@saidsef/tracing-node 6.1.0 → 7.0.0

package/README.md

@@ -26,6 +26,14 @@ Full documentation: [tracing-node.readthedocs.io](https://tracing-node.readthedo
 npm install @saidsef/tracing-node --save
 ```
 
+Elasticsearch spans carrying the query, the operation and the index name need an optional peer dependency:
+
+```shell
+npm install opentelemetry-instrumentation-elasticsearch --save
+```
+
+That package pins `@opentelemetry/core` to the 1.x line, so installing it brings [GHSA-8988-4f7v-96qf](https://github.com/advisories/GHSA-8988-4f7v-96qf) into the dependency tree. Without it, an Elasticsearch call is still traced as an HTTP client span and still appears on the service graph. See [Instrumentation](https://tracing-node.readthedocs.io/en/latest/instrumentation/) for what each option records.
+
 ## Usage
 
 ```javascript

package/libs/index.mjs

@@ -23,7 +23,6 @@ import {ConnectInstrumentation} from '@opentelemetry/instrumentation-connect';
 import {diag, DiagConsoleLogger, DiagLogLevel, metrics} from '@opentelemetry/api';
 import {HttpInstrumentation} from '@opentelemetry/instrumentation-http';
 import {DnsInstrumentation} from '@opentelemetry/instrumentation-dns';
-import {ElasticsearchInstrumentation} from 'opentelemetry-instrumentation-elasticsearch';
 import {ExpressInstrumentation, ExpressLayerType} from '@opentelemetry/instrumentation-express';
 import {logs} from '@opentelemetry/api-logs';
 import {NodeTracerProvider} from '@opentelemetry/sdk-trace-node';
@@ -50,6 +49,21 @@ if (esmHookFailure) {
   diag.warn(`ESM loader hook not registered, so ES module imports are not instrumented: ${esmHookFailure.message}`);
 }
 
+// An optional peer dependency: it pins @opentelemetry/core 1.x, which carries a
+// published advisory. Absent, an Elasticsearch call still gets a client span from
+// the http or undici instrumentation. See #576.
+let ElasticsearchInstrumentation = null;
+try {
+  ({ElasticsearchInstrumentation} = await import('opentelemetry-instrumentation-elasticsearch'));
+} catch (error) {
+  // Absence is the expected case. An installed but unloadable package would
+  // otherwise vanish silently, and tracing must not take the application down.
+  if (error?.code !== 'ERR_MODULE_NOT_FOUND') {
+    diag.warn('opentelemetry-instrumentation-elasticsearch failed to load:', error);
+  }
+}
+
+
 // Set a non-negative integer span attribute from a header value; ignore invalid input.
 const setIntAttribute = (span, name, value) => {
   if (!value) return;
@@ -116,9 +130,10 @@ let loggerProvider = null;
 *
 * This function configures a NodeTracerProvider with various instrumentations
 * and span processors to enable tracing for the application. It supports
-* tracing for HTTP, Express, AWS, Pino, DNS, Elasticsearch, and IORedis.
-* The IORedis instrumentation includes peer.service attributes for proper
-* service map visualization in distributed tracing tools like Tempo.
+* tracing for HTTP, Express, AWS, Pino, DNS, and IORedis, and for Elasticsearch
+* when the optional opentelemetry-instrumentation-elasticsearch package is
+* installed. The IORedis instrumentation includes peer.service attributes for
+* proper service map visualization in distributed tracing tools like Tempo.
 *
 * A MeterProvider is registered alongside it, which is what makes the
 * instrumentations record the request duration histograms they already
@@ -356,7 +371,7 @@ export function setupTracing(options = {}) {
         return `${cmdName} ${args.join(' ')}`;
       },
     }),
-    new ElasticsearchInstrumentation(),
+    ...(ElasticsearchInstrumentation ? [new ElasticsearchInstrumentation()] : []),
     // Event loop delay, GC pauses and heap occupancy are metric-only, and they
     // are what explains a whole service slowing at once. Constructed only with
     // metrics on, since the collectors start sampling on construction.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "6.1.0",
+  "version": "7.0.0",
   "description": "tracing NodeJS - Wrapper for OpenTelemetry instrumentation packages",
   "main": "libs/index.mjs",
   "scripts": {
@@ -54,15 +54,21 @@
     "@opentelemetry/sdk-trace-base": "^2.11.0",
     "@opentelemetry/sdk-trace-node": "^2.11.0",
     "@opentelemetry/semantic-conventions": "^1.43.0",
-    "import-in-the-middle": "^3.0.0",
-    "opentelemetry-instrumentation-elasticsearch": "^0.41.0"
+    "import-in-the-middle": "^3.0.0"
   },
   "devDependencies": {
     "eslint": "^10.10.0"
   },
+  "peerDependencies": {
+    "opentelemetry-instrumentation-elasticsearch": "^0.41.0"
+  },
+  "peerDependenciesMeta": {
+    "opentelemetry-instrumentation-elasticsearch": {
+      "optional": true
+    }
+  },
   "overrides": {
-    "protobufjs": "^7.5.3",
-    "@opentelemetry/core": "^2.11.0"
+    "protobufjs": "^7.5.3"
   },
   "allowScripts": {
     "protobufjs@7.6.6": true