@saidsef/tracing-node 3.10.0 → 3.11.1

package/README.md

@@ -12,19 +12,21 @@ 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.
 
 ## 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
+| Feature | Description |
+|---------|-------------|
+| HTTP/HTTPS instrumentation | Automatic service detection |
+| Express.js support | Framework instrumentation |
+| Elasticsearch client | Database instrumentation |
+| IORedis client | Cache instrumentation |
+| AWS SDK | Cloud service instrumentation |
+| Pino logger | Integration with trace/span IDs |
+| DNS/FS instrumentation | Optional monitoring |
+| Resource detection | Host, OS, process, container |
+| W3C Trace Context | Standard propagation |
 
 ## Prerequisites
 - NodeJS
+- Observability
 - ...
 - Profit?
 

package/libs/index.mjs

@@ -132,14 +132,113 @@ export function setupTracing(options = {}) {
   // Register instrumentations
   const instrumentations = [
     new HttpInstrumentation({
-      serverName: serviceName, 
+      serverName: serviceName,
       ignoreIncomingRequestHook,
       applyCustomAttributesOnSpan,
+      requestHook: (span, request) => {
+        // Enrich spans with additional HTTP request attributes
+        if (request.headers) {
+          const userAgent = request.headers['user-agent'];
+          const contentType = request.headers['content-type'];
+          const contentLength = request.headers['content-length'];
+
+          if (userAgent) span.setAttribute('http.user_agent', userAgent);
+          if (contentType) span.setAttribute('http.request.content_type', contentType);
+          if (contentLength) span.setAttribute('http.request.content_length', parseInt(contentLength, 10));
+        }
+      },
+      responseHook: (span, response) => {
+        // Add response attributes for better observability
+        if (response.headers) {
+          const contentType = response.headers['content-type'];
+          const contentLength = response.headers['content-length'];
+
+          if (contentType) span.setAttribute('http.response.content_type', contentType);
+          if (contentLength) span.setAttribute('http.response.content_length', parseInt(contentLength, 10));
+        }
+      },
+      headersToSpanAttributes: {
+        server: {
+          requestHeaders: ['x-request-id', 'x-correlation-id', 'x-trace-id'],
+          responseHeaders: ['x-request-id', 'x-correlation-id'],
+        },
+        client: {
+          requestHeaders: ['x-request-id', 'x-correlation-id', 'x-trace-id'],
+          responseHeaders: ['x-request-id', 'x-correlation-id'],
+        },
+      },
+    }),
+    new ExpressInstrumentation({
+      ignoreIncomingRequestHook,
+      requestHook: (span, request) => {
+        // Add Express-specific attributes
+        if (request.route?.path) {
+          span.setAttribute('express.route', request.route.path);
+          span.updateName(`${request.method} ${request.route.path}`);
+        }
+        if (request.params && Object.keys(request.params).length > 0) {
+          span.setAttribute('express.params', JSON.stringify(request.params));
+        }
+        if (request.query && Object.keys(request.query).length > 0) {
+          span.setAttribute('express.query', JSON.stringify(request.query));
+        }
+        // Add user context if available
+        if (request.user?.id) {
+          span.setAttribute('user.id', request.user.id);
+        }
+      },
+    }),
+    new PinoInstrumentation({
+      logHook: (span, record) => {
+        // Inject trace context into log records
+        const spanContext = span.spanContext();
+        record['trace_id'] = spanContext.traceId;
+        record['span_id'] = spanContext.spanId;
+        record['trace_flags'] = `0${spanContext.traceFlags.toString(16)}`;
+
+        // Add service name for better log correlation
+        if (serviceName) {
+          record['service.name'] = serviceName;
+        }
+      },
+      logSeverity: {
+        error: 'ERROR',
+        warn: 'WARN',
+        info: 'INFO',
+        debug: 'DEBUG',
+        trace: 'TRACE',
+      },
+    }),
+    new ConnectInstrumentation({
+      ignoreIncomingRequestHook,
+      requestHook: (span, request) => {
+        // Add Connect middleware attributes
+        if (request.url) {
+          span.setAttribute('connect.url', request.url);
+        }
+        if (request.method) {
+          span.setAttribute('connect.method', request.method);
+        }
+      },
+    }),
+    new AwsInstrumentation({
+      suppressInternalInstrumentation: false,
+      sqsExtractContextPropagationFromPayload: true,
+      preRequestHook: (span, request) => {
+        // Add peer.service attribute for better service map visualization
+        const serviceName = request.serviceName || request.service?.serviceIdentifier;
+        if (serviceName) {
+          span.setAttribute('peer.service', serviceName.toLowerCase());
+          span.setAttribute('aws.service', serviceName.toLowerCase());
+        }
+      },
+      responseHook: (span, response) => {
+        // Add additional attributes from response if available
+        if (response?.requestId) {
+          span.setAttribute('aws.request_id', response.requestId);
+        }
+      },
     }),
-    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({
       responseHook: (span) => {
         span.setAttribute('peer.service', 'redis');
@@ -160,7 +259,57 @@ export function setupTracing(options = {}) {
   if (enableDnsInstrumentation) {
     // Enable DNS instrumentation if specified
     // This instrumentation is useful for tracing DNS operations.
-    instrumentations.push(new DnsInstrumentation());
+    instrumentations.push(new DnsInstrumentation({
+      ignoreHostnames: ['localhost', '127.0.0.1', '::1'],
+      requestHook: (span, request) => {
+        // Add DNS query details for better observability
+        if (request.hostname) {
+          span.setAttribute('dns.hostname', request.hostname);
+          span.updateName(`DNS ${request.hostname}`);
+        }
+        if (request.rrtype) {
+          span.setAttribute('dns.record_type', request.rrtype);
+        }
+        // Add additional context
+        span.setAttribute('peer.service', 'dns');
+        span.setAttribute('dns.query_count', 1);
+      },
+      responseHook: (span, response) => {
+        // Add DNS response details
+        if (Array.isArray(response)) {
+          span.setAttribute('dns.result_count', response.length);
+          // Log first few results for debugging (limit to avoid overwhelming spans)
+          const resultSample = response.slice(0, 3).map(r => 
+            typeof r === 'string' ? r : JSON.stringify(r)
+          );
+          if (resultSample.length > 0) {
+            span.setAttribute('dns.results', JSON.stringify(resultSample));
+          }
+        } else if (response) {
+          span.setAttribute('dns.result_count', 1);
+          span.setAttribute('dns.result', typeof response === 'string' ? response : JSON.stringify(response));
+        }
+      },
+      errorHook: (span, error) => {
+        // Enhanced error tracking for DNS failures
+        if (error) {
+          span.setAttribute('dns.error', true);
+          span.setAttribute('dns.error.code', error.code || 'UNKNOWN');
+          span.setAttribute('dns.error.message', error.message || 'DNS lookup failed');
+
+          // Categorize common DNS errors
+          if (error.code === 'ENOTFOUND') {
+            span.setAttribute('dns.error.type', 'NOT_FOUND');
+          } else if (error.code === 'ETIMEOUT') {
+            span.setAttribute('dns.error.type', 'TIMEOUT');
+          } else if (error.code === 'ECONNREFUSED') {
+            span.setAttribute('dns.error.type', 'CONNECTION_REFUSED');
+          } else {
+            span.setAttribute('dns.error.type', 'OTHER');
+          }
+        }
+      },
+    }));
   }
 
   // Register instrumentations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "3.10.0",
+  "version": "3.11.1",
   "description": "tracing NodeJS - Wrapper for OpenTelemetry instrumentation packages",
   "main": "libs/index.mjs",
   "scripts": {
@@ -32,16 +32,16 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/context-async-hooks": "^2.0.1",
-    "@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/exporter-trace-otlp-grpc": "^0.208.0",
+    "@opentelemetry/instrumentation": "^0.208.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.64.0",
+    "@opentelemetry/instrumentation-connect": "^0.52.0",
+    "@opentelemetry/instrumentation-dns": "^0.52.0",
+    "@opentelemetry/instrumentation-express": "^0.57.0",
+    "@opentelemetry/instrumentation-fs": "^0.28.0",
+    "@opentelemetry/instrumentation-http": "^0.208.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.56.0",
+    "@opentelemetry/instrumentation-pino": "^0.55.0",
     "@opentelemetry/resources": "^2.0.1",
     "@opentelemetry/sdk-trace-base": "^2.0.0",
     "@opentelemetry/sdk-trace-node": "^2.0.0",