test: add a test for native @elastic/elasticsearch instrumentation

examples/package.json

@@ -5,6 +5,7 @@
   "version": "0.1.0",
   "scripts": {},
   "devDependencies": {
+    "@elastic/elasticsearch": "^8.14.0",
     "@elastic/opentelemetry-node": "*",
     "bunyan": "^1.8.15",
     "express": "^4.19.2"

packages/opentelemetry-node/package.json

@@ -117,6 +117,7 @@
     "@aws-sdk/client-s3": "^3.606.0",
     "@aws-sdk/client-sns": "^3.606.0",
     "@aws-sdk/client-sqs": "^3.606.0",
+    "@elastic/elasticsearch": "^8.14.0",
     "@elastic/mockotlpserver": "*",
     "@grpc/grpc-js": "^1.10.10",
     "@grpc/proto-loader": "^0.7.13",

packages/opentelemetry-node/test/docker-compose.yaml

@@ -11,6 +11,22 @@
 name: test-services
 
 services:
+  elasticsearch:
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.14.2
+    environment:
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+      - "network.host=_site_"
+      - "transport.host=127.0.0.1"
+      - "http.host=0.0.0.0"
+      - "xpack.security.enabled=false"
+    ports:
+      - "9200:9200"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:9200"]
+      interval: 1s
+      timeout: 10s
+      retries: 30
+
   redis:
     image: redis:7
     ports:

packages/opentelemetry-node/test/fixtures/use-elasticsearch.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node --unhandled-rejections=strict
+
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+// Usage:
+//   npm run test-services:start elasticsearch
+//   node -r @elastic/opentelemetry-node use-elasticsearch.js
+//   npm run test-services:stop
+
+const {Client} = require('@elastic/elasticsearch');
+
+const client = new Client({
+    node: process.env.ES_URL || 'http://localhost:9200',
+    auth: {
+        username: process.env.ES_USERNAME || undefined,
+        password: process.env.ES_PASSWORD || undefined,
+    },
+    maxRetries: 1,
+});
+
+async function run() {
+    try {
+        const res = await client.search({q: 'pants'});
+        console.log('search hits:', res.hits);
+    } catch (err) {
+        console.log('search error:', err.message);
+    }
+}
+
+run();

packages/opentelemetry-node/test/instr-elasticsearch.test.js

@@ -0,0 +1,67 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+// Test the *native* OTel instrumentation for `@elastic/elasticsearch` 8.15.0
+// and later.
+
+const test = require('tape');
+const {filterOutDnsNetSpans, runTestFixtures} = require('./testutils');
+
+const skip = process.env.ES_URL === undefined;
+if (skip) {
+    console.log(
+        '# SKIP elasticsearch tests: ES_URL is not set (try with `ES_URL=http://localhost:9200`)'
+    );
+}
+
+/** @type {import('./testutils').TestFixture[]} */
+const testFixtures = [
+    {
+        name: 'use-elasticsearch.js (CommonJS)',
+        args: ['./fixtures/use-elasticsearch.js'],
+        cwd: __dirname,
+        env: {
+            NODE_OPTIONS: '--require=@elastic/opentelemetry-node',
+        },
+        versionRanges: {
+            // Min-supported node by @elastic/[email protected].
+            node: '>=18',
+        },
+        // verbose: true,
+        checkTelemetry: (t, col) => {
+            // Expected a trace like this:
+            // XXX
+            const spans = filterOutDnsNetSpans(col.sortedSpans);
+            console.log('XXX spans: ', spans);
+            // t.equal(spans.length, 6);
+            // spans.slice(1).forEach((s) => {
+            //     t.equal(s.traceId, spans[0].traceId, 'traceId');
+            //     t.equal(s.parentSpanId, spans[0].spanId, 'parentSpanId');
+            //     t.equal(s.kind, 'SPAN_KIND_CLIENT', 'kind');
+            //     t.equal(s.scope.name, '@elastic/transport');
+            //     t.equal(s.attributes['db.system'], 'elasticsearch');
+            // });
+        },
+    },
+];
+
+test('elasticsearch instrumentation', {skip}, (suite) => {
+    runTestFixtures(suite, testFixtures);
+    suite.end();
+});

packages/opentelemetry-node/test/test-services.env

@@ -1,4 +1,5 @@
 REDIS_HOST=localhost
 PGHOST=localhost
 MONGODB_HOST=localhost
-MSSQL_HOST=localhost
+MSSQL_HOST=localhost
+ES_URL=http://localhost:9200  # Elasticsearch