@saidsef/tracing-node 3.13.6 → 3.14.0

package/libs/index.mjs

@@ -85,14 +85,21 @@ export function setupTracing(options = {}) {
 
   // Configure exporter with the Collector endpoint - uses gRPC
   const exportOptions = {
-    concurrencyLimit: parseInt(concurrencyLimit, 10),
-    url: url,
-    timeoutMillis: 1000,
+    concurrencyLimit,
+    url,
+    timeoutMillis: 10000,
   };
 
   // Register the span processor with the tracer provider
   const exporter = new OTLPTraceExporter(exportOptions);
-  const spanProcessor = new BatchSpanProcessor(exporter);
+
+  // Configure BatchSpanProcessor for production workloads
+  const spanProcessor = new BatchSpanProcessor(exporter, {
+    maxQueueSize: 4096,
+    maxExportBatchSize: 1024,
+    scheduledDelayMillis: 2000,
+    exportTimeoutMillis: 10000,
+  });
 
   tracerProvider = new NodeTracerProvider({
     spanProcessors: [spanProcessor],
@@ -151,35 +158,52 @@ export function setupTracing(options = {}) {
       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));
+        if (!request.headers) return;
+
+        const headers = request.headers;
+
+        // Safe header extraction with case-insensitive fallback
+        const userAgent = headers['user-agent'] || headers['User-Agent'];
+        const contentType = headers['content-type'] || headers['Content-Type'];
+        const contentLength = headers['content-length'] || headers['Content-Length'];
+        const requestId = headers['x-request-id'] || headers['X-Request-ID'];
+        const correlationId = headers['x-correlation-id'] || headers['X-Correlation-ID'];
+
+        // Only set attributes if values exist
+        if (userAgent) span.setAttribute('http.user_agent', userAgent);
+        if (contentType) span.setAttribute('http.request.content_type', contentType);
+
+        // Safe integer parsing with validation
+        if (contentLength) {
+          const length = parseInt(contentLength, 10);
+          if (!Number.isNaN(length) && length >= 0) {
+            span.setAttribute('http.request.content_length', length);
+          }
         }
+
+        // Correlation headers for distributed tracing
+        if (requestId) span.setAttribute('http.request_id', requestId);
+        if (correlationId) span.setAttribute('http.correlation_id', correlationId);
       },
       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 (!response.headers) return;
+
+        const headers = response.headers;
+        const contentType = headers['content-type'] || headers['Content-Type'];
+        const contentLength = headers['content-length'] || headers['Content-Length'];
+        const requestId = headers['x-request-id'] || headers['X-Request-ID'];
 
-          if (contentType) span.setAttribute('http.response.content_type', contentType);
-          if (contentLength) span.setAttribute('http.response.content_length', parseInt(contentLength, 10));
+        if (contentType) span.setAttribute('http.response.content_type', contentType);
+
+        if (contentLength) {
+          const length = parseInt(contentLength, 10);
+          if (!Number.isNaN(length) && length >= 0) {
+            span.setAttribute('http.response.content_length', length);
+          }
         }
-      },
-      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'],
-        },
+
+        if (requestId) span.setAttribute('http.request_id', requestId);
       },
     }),
     new ExpressInstrumentation({
@@ -409,3 +433,12 @@ export async function stopTracing() {
     console.warn('Tracer provider is not initialized.');
   }
 }
+
+/**
+ * @internal
+ * Resets the tracer provider for testing purposes.
+ * DO NOT use in production code.
+ */
+export function __resetTracingForTesting() {
+  tracerProvider = null;
+}

package/libs/index.test.mjs

@@ -1,14 +1,30 @@
 // index.test.mjs
-import { describe, it, beforeEach } from 'node:test';
+import { describe, it, beforeEach, afterEach } from 'node:test';
 import assert from 'node:assert';
 
 describe('setupTracing', () => {
-  // Clear environment before each test
-  beforeEach(() => {
+  let stopTracing;
+
+  // Clear environment and reset tracing state before each test
+  beforeEach(async () => {
     delete process.env.SERVICE_NAME;
     delete process.env.ENDPOINT;
     delete process.env.HOSTNAME;
     delete process.env.CONTAINER_NAME;
+
+    // Import and store stopTracing for cleanup
+    const tracing = await import('./index.mjs');
+    stopTracing = tracing.stopTracing;
+
+    // Reset singleton for test isolation
+    tracing.__resetTracingForTesting();
+  });
+
+  // Clean up tracing after each test
+  afterEach(async () => {
+    if (stopTracing) {
+      await stopTracing();
+    }
   });
 
   it('should throw error when serviceName is not provided', async () => {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "3.13.6",
+  "version": "3.14.0",
   "description": "tracing NodeJS - Wrapper for OpenTelemetry instrumentation packages",
   "main": "libs/index.mjs",
   "scripts": {
-    "test": "node --trace-warnings --test --report-uncaught-exception --heap-prof --cpu-prof --track-heap-objects --report-dir=test/ --diagnostic-dir=test/ --heap-prof-dir=test/ libs/index.test.mjs",
+    "test": "node --trace-warnings --test --report-uncaught-exception libs/index.test.mjs",
     "lint": "eslint .",
     "rebuild": "rm -rfv node_modules/ package-lock.json && npm install --prod --omit=dev"
   },
@@ -34,14 +34,14 @@
     "@opentelemetry/context-async-hooks": "^2.0.1",
     "@opentelemetry/exporter-trace-otlp-grpc": "^0.213.0",
     "@opentelemetry/instrumentation": "^0.213.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.67.0",
-    "@opentelemetry/instrumentation-connect": "^0.55.0",
-    "@opentelemetry/instrumentation-dns": "^0.55.0",
-    "@opentelemetry/instrumentation-express": "^0.60.0",
-    "@opentelemetry/instrumentation-fs": "^0.31.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.68.0",
+    "@opentelemetry/instrumentation-connect": "^0.56.0",
+    "@opentelemetry/instrumentation-dns": "^0.56.0",
+    "@opentelemetry/instrumentation-express": "^0.61.0",
+    "@opentelemetry/instrumentation-fs": "^0.32.0",
     "@opentelemetry/instrumentation-http": "^0.213.0",
-    "@opentelemetry/instrumentation-ioredis": "^0.60.0",
-    "@opentelemetry/instrumentation-pino": "^0.58.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.61.0",
+    "@opentelemetry/instrumentation-pino": "^0.59.0",
     "@opentelemetry/resources": "^2.0.1",
     "@opentelemetry/sdk-trace-base": "^2.0.0",
     "@opentelemetry/sdk-trace-node": "^2.0.0",
@@ -51,5 +51,8 @@
   "devDependencies": {
     "eslint": "^9.30.0",
     "jest": "^30.0.0"
+  },
+  "overrides": {
+    "protobufjs": "^7.5.3"
   }
 }