@saidsef/tracing-node 3.11.0 → 3.12.0

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

@@ -109,24 +109,61 @@ 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 || '';
+  // Helper function to extract hostname from various request formats
+  const extractHostname = (request) => {
+    // Try to get hostname from various possible locations
+    let 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');
+    // If not found, try to parse from URL
+    if (!hostname && request?.url) {
+      try {
+        const urlObj = new URL(request.url);
+        hostname = urlObj.hostname;
+      } catch {
+        // If URL parsing fails, try to extract from request options
+        if (request?.options?.hostname) {
+          hostname = request.options.hostname;
+        } else if (request?.options?.host) {
+          hostname = request.options.host;
+        }
+      }
     }
 
-    // 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');
+    return hostname;
+  };
+
+  // Helper function to determine peer service name from hostname/URL
+  const getPeerServiceName = (hostname, url = '') => {
+    const lowerHostname = hostname.toLowerCase();
+    const lowerUrl = url.toLowerCase();
+
+    // Check for known service patterns
+    if (lowerHostname.includes('elasticsearch') || lowerUrl.includes('elasticsearch') ||
+        lowerHostname.includes(':9200') || lowerUrl.includes(':9200')) {
+      return 'elasticsearch';
     }
+
+    if (lowerHostname.includes('redis') || lowerUrl.includes('redis') ||
+        lowerHostname.includes(':6379') || lowerUrl.includes(':6379')) {
+      return 'redis';
+    }
+
+    // Extract service name from hostname patterns like:
+    // - service-name.namespace.svc.cluster.local
+    // - service-name.namespace.svc
+    // - api.service-name.com
+    if (lowerHostname.includes('.svc')) {
+      const parts = lowerHostname.split('.');
+      return parts[0]; // Return the service name part
+    }
+
+    // For external domains, use the hostname without 'www'
+    if (lowerHostname.startsWith('www.')) {
+      return lowerHostname.substring(4);
+    }
+
+    // Return the full hostname as the service name
+    return hostname || 'unknown';
   };
 
   // Register instrumentations
@@ -134,8 +171,39 @@ export function setupTracing(options = {}) {
     new HttpInstrumentation({
       serverName: serviceName,
       ignoreIncomingRequestHook,
-      applyCustomAttributesOnSpan,
+      requireParentforOutgoingSpans: false,
+      requireParentforIncomingSpans: false,
       requestHook: (span, request) => {
+        const spanKind = span.kind;
+        const isClientSpan = spanKind === 3; // SpanKind.CLIENT = 3
+
+        // For CLIENT spans (outgoing requests), add peer service attributes
+        if (isClientSpan) {
+          const hostname = extractHostname(request);
+          const url = request?.url || request?.uri || '';
+
+          if (hostname) {
+            const peerService = getPeerServiceName(hostname, url);
+
+            // Set attributes for service graph
+            span.setAttribute('peer.service', peerService);
+            span.setAttribute('net.peer.name', hostname);
+
+            // Add port if available
+            const port = request?.port || request?.options?.port;
+            if (port) {
+              span.setAttribute('net.peer.port', parseInt(port, 10));
+            }
+
+            // Add method for better span naming
+            const method = request?.method || 'GET';
+            span.setAttribute('http.method', method.toUpperCase());
+
+            // Update span name for clarity
+            span.updateName(`${method.toUpperCase()} ${peerService}`);
+          }
+        }
+
         // Enrich spans with additional HTTP request attributes
         if (request.headers) {
           const userAgent = request.headers['user-agent'];
@@ -240,11 +308,55 @@ export function setupTracing(options = {}) {
       },
     }),
     new IORedisInstrumentation({
-      responseHook: (span) => {
+      requireParentSpan: false,
+      responseHook: (span, cmdName, cmdArgs, response) => {
+        // Set peer.service for service graph visualization
         span.setAttribute('peer.service', 'redis');
+        span.setAttribute('db.system', 'redis');
+
+        // Add command details for better observability
+        if (cmdName) {
+          span.setAttribute('db.operation', cmdName.toUpperCase());
+        }
+
+        // Log response size if available
+        if (response !== undefined && response !== null) {
+          const responseType = typeof response;
+          span.setAttribute('db.response.type', responseType);
+
+          if (Array.isArray(response)) {
+            span.setAttribute('db.response.count', response.length);
+          }
+        }
       },
-      requestHook: (span) => {
+      requestHook: (span, cmdName, cmdArgs) => {
+        // Set peer.service for service graph visualization - CRITICAL for Tempo
         span.setAttribute('peer.service', 'redis');
+        span.setAttribute('db.system', 'redis');
+
+        // Add command details
+        if (cmdName) {
+          span.setAttribute('db.operation', cmdName.toUpperCase());
+          span.updateName(`redis.${cmdName.toUpperCase()}`);
+        }
+
+        // Add key information (first argument is usually the key)
+        if (cmdArgs && cmdArgs.length > 0) {
+          span.setAttribute('db.redis.key', String(cmdArgs[0]));
+
+          // For operations with multiple keys or complex args
+          if (cmdArgs.length > 1) {
+            span.setAttribute('db.redis.args_count', cmdArgs.length);
+          }
+        }
+      },
+      dbStatementSerializer: (cmdName, cmdArgs) => {
+        // Serialize command for better observability (limit arg length to avoid huge spans)
+        const args = cmdArgs.map(arg => {
+          const str = String(arg);
+          return str.length > 100 ? `${str.substring(0, 100)}...` : str;
+        });
+        return `${cmdName} ${args.join(' ')}`;
       },
     }),
     new ElasticsearchInstrumentation(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "3.11.0",
+  "version": "3.12.0",
   "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",