@saidsef/tracing-node 3.8.4 → 3.10.0

package/README.md

@@ -9,7 +9,19 @@
 
 Get telemetry for your app in less than 3 minutes!
 
-Effortlessly supercharge your applications with world-class distributed tracing! This OpenTelemetry wrapper delivers seamless, lightning-fast observability, empowering developers to monitor, debug, and optimise microservices with ease. Designed for modern cloud-native environments, it’s the smart choice for engineers who demand reliability, scalability, and actionable insights. Get started in minutes and unlock the full potential of your service architecture—no fuss, just results.  This is to make instrumentation (more) idempotent.
+Effortlessly supercharge your applications with world-class distributed tracing! This OpenTelemetry wrapper delivers seamless, lightning-fast observability, empowering developers to monitor, debug, and optimise microservices with ease. Designed for modern cloud-native environments, it's the smart choice for engineers who demand reliability, scalability, and actionable insights. Get started in minutes and unlock the full potential of your service architecture—no fuss, just results.  This is to make instrumentation (more) idempotent.
+
+## Features
+
+- ✅ HTTP/HTTPS instrumentation with automatic service detection
+- ✅ Express.js framework support
+- ✅ Elasticsearch client instrumentation
+- ✅ IORedis client instrumentation  
+- ✅ AWS SDK instrumentation
+- ✅ Pino logger integration with trace/span IDs
+- ✅ Optional DNS and File System instrumentation
+- ✅ Automatic resource detection (host, OS, process, container)
+- ✅ W3C Trace Context propagation
 
 ## Prerequisites
 - NodeJS

package/libs/index.mjs

@@ -24,6 +24,7 @@ import {ConnectInstrumentation} from '@opentelemetry/instrumentation-connect';
 import {diag, DiagConsoleLogger, DiagLogLevel} from '@opentelemetry/api';
 import {HttpInstrumentation} from '@opentelemetry/instrumentation-http';
 import {DnsInstrumentation} from '@opentelemetry/instrumentation-dns';
+import {ElasticsearchInstrumentation} from 'opentelemetry-instrumentation-elasticsearch';
 import {ExpressInstrumentation} from '@opentelemetry/instrumentation-express';
 import {NodeTracerProvider} from '@opentelemetry/sdk-trace-node';
 import {OTLPTraceExporter} from '@opentelemetry/exporter-trace-otlp-grpc';
@@ -42,7 +43,9 @@ diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO);
 *
 * 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, and DNS.
+* 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.
 *
 * @param {Object} options - Configuration options for tracing.
 * @param {string} [options.hostname=process.env.HOSTNAME] - The hostname of the service.
@@ -106,14 +109,46 @@ export function setupTracing(options = {}) {
     return req.url.startsWith('/metrics') || req.url.startsWith('/healthz');
   };
 
+  // Hook to set peer service name for outgoing requests
+  const applyCustomAttributesOnSpan = (span, request) => {
+    const url = request?.url || request?.uri || '';
+    const hostname = request?.hostname || request?.host || '';
+    
+    // Detect Elasticsearch endpoints
+    if (hostname.includes('elasticsearch') || url.includes('elasticsearch') || 
+        hostname.includes(':9200') || url.includes(':9200')) {
+      span.setAttribute('peer.service', 'elasticsearch');
+      span.setAttribute('db.system', 'elasticsearch');
+    }
+
+    // Detect Redis endpoints
+    if (hostname.includes('redis') || url.includes('redis') || 
+        hostname.includes(':6379') || url.includes(':6379')) {
+      span.setAttribute('peer.service', 'redis');
+      span.setAttribute('db.system', 'redis');
+    }
+  };
+
   // Register instrumentations
   const instrumentations = [
-    new HttpInstrumentation({serverName: serviceName, ignoreIncomingRequestHook,}),
+    new HttpInstrumentation({
+      serverName: serviceName, 
+      ignoreIncomingRequestHook,
+      applyCustomAttributesOnSpan,
+    }),
     new ExpressInstrumentation({ ignoreIncomingRequestHook, }),
     new PinoInstrumentation({logHook: (span, record) => {record['trace_id'] = span.spanContext().traceId;record['span_id'] = span.spanContext().spanId;},}),
     new ConnectInstrumentation(),
     new AwsInstrumentation({ sqsExtractContextPropagationFromPayload: true, }),
-    new IORedisInstrumentation(),
+    new IORedisInstrumentation({
+      responseHook: (span) => {
+        span.setAttribute('peer.service', 'redis');
+      },
+      requestHook: (span) => {
+        span.setAttribute('peer.service', 'redis');
+      },
+    }),
+    new ElasticsearchInstrumentation(),
   ];
 
   if (enableFsInstrumentation) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "3.8.4",
+  "version": "3.10.0",
   "description": "tracing NodeJS - Wrapper for OpenTelemetry instrumentation packages",
   "main": "libs/index.mjs",
   "scripts": {
@@ -32,20 +32,21 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/context-async-hooks": "^2.0.1",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.206.0",
-    "@opentelemetry/instrumentation": "^0.206.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.62.0",
-    "@opentelemetry/instrumentation-connect": "^0.50.0",
-    "@opentelemetry/instrumentation-dns": "^0.50.0",
-    "@opentelemetry/instrumentation-express": "^0.55.0",
-    "@opentelemetry/instrumentation-fs": "^0.26.0",
-    "@opentelemetry/instrumentation-http": "^0.206.0",
-    "@opentelemetry/instrumentation-ioredis": "^0.54.0",
-    "@opentelemetry/instrumentation-pino": "^0.53.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.207.0",
+    "@opentelemetry/instrumentation": "^0.207.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.63.0",
+    "@opentelemetry/instrumentation-connect": "^0.51.0",
+    "@opentelemetry/instrumentation-dns": "^0.51.0",
+    "@opentelemetry/instrumentation-express": "^0.56.0",
+    "@opentelemetry/instrumentation-fs": "^0.27.0",
+    "@opentelemetry/instrumentation-http": "^0.207.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.55.0",
+    "@opentelemetry/instrumentation-pino": "^0.54.0",
     "@opentelemetry/resources": "^2.0.1",
     "@opentelemetry/sdk-trace-base": "^2.0.0",
     "@opentelemetry/sdk-trace-node": "^2.0.0",
-    "@opentelemetry/semantic-conventions": "^1.28.0"
+    "@opentelemetry/semantic-conventions": "^1.28.0",
+    "opentelemetry-instrumentation-elasticsearch": "^0.41.0"
   },
   "devDependencies": {
     "eslint": "^9.30.0",