@saidsef/tracing-node 3.13.4 → 3.13.6

package/libs/index.mjs

@@ -60,6 +60,12 @@ diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO);
 let tracerProvider = null; // Declare provider in module scope for access in stopTracing
 
 export function setupTracing(options = {}) {
+  // Prevent multiple initializations - return existing provider if already set up
+  if (tracerProvider) {
+    console.warn('Tracing is already initialized. Returning existing tracer.');
+    return tracerProvider.getTracer(options.serviceName || process.env.SERVICE_NAME);
+  }
+
   const {
     hostname = process.env.CONTAINER_NAME || process.env.HOSTNAME,
     serviceName = process.env.SERVICE_NAME,
@@ -69,6 +75,14 @@ export function setupTracing(options = {}) {
     enableDnsInstrumentation = false,
   } = options;
 
+  // Validate required parameters
+  if (!serviceName) {
+    throw new Error('serviceName is required');
+  }
+  if (!url) {
+    throw new Error('url is required');
+  }
+
   // Configure exporter with the Collector endpoint - uses gRPC
   const exportOptions = {
     concurrencyLimit: parseInt(concurrencyLimit, 10),
@@ -386,6 +400,7 @@ export async function stopTracing() {
   if (tracerProvider) {
     try {
       await tracerProvider.shutdown();
+      tracerProvider = null;
       console.info('Tracing has been successfully shut down.');
     } catch (error) {
       console.error('Error during tracing shutdown:', error);

package/libs/index.test.mjs

@@ -1,62 +1,57 @@
-// tracing.test.mjs
-import { setupTracing } from './index.mjs';
-import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
-import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
-import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
-
-// Mocking external dependencies
-jest.mock('@opentelemetry/sdk-trace-node', () => {
-  const originalModule = jest.requireActual('@opentelemetry/sdk-trace-node');
-  return {
-    ...originalModule,
-    NodeTracerProvider: jest.fn().mockImplementation(() => ({
-      addSpanProcessor: jest.fn(),
-      register: jest.fn(),
-      getTracer: jest.fn().mockReturnValue({}),
-      resource: {
-        attributes: {},
-      },
-    })),
-  };
-});
-
-jest.mock('@opentelemetry/sdk-trace-base', () => ({
-  BatchSpanProcessor: jest.fn(),
-  SpanProcessor: jest.fn(),
-}));
-
-jest.mock('@opentelemetry/exporter-trace-otlp-grpc', () => ({
-  OTLPTraceExporter: jest.fn(),
-}));
+// index.test.mjs
+import { describe, it, beforeEach } from 'node:test';
+import assert from 'node:assert';
 
 describe('setupTracing', () => {
+  // Clear environment before each test
   beforeEach(() => {
-    // Clear all instances and calls to constructor and all methods:
-    NodeTracerProvider.mockClear();
-    BatchSpanProcessor.mockClear();
-    OTLPTraceExporter.mockClear();
+    delete process.env.SERVICE_NAME;
+    delete process.env.ENDPOINT;
+    delete process.env.HOSTNAME;
+    delete process.env.CONTAINER_NAME;
+  });
+
+  it('should throw error when serviceName is not provided', async () => {
+    const { setupTracing } = await import('./index.mjs');
+    assert.throws(() => {
+      setupTracing({ url: 'http://localhost:4317' });
+    }, /serviceName is required/);
   });
 
-  it('should create a tracer with default parameters', () => {
-    const tracer = setupTracing('test-service');
-    expect(NodeTracerProvider).toHaveBeenCalledTimes(1);
-    expect(BatchSpanProcessor).toHaveBeenCalledTimes(1);
-    expect(OTLPTraceExporter).toHaveBeenCalledWith({
+  it('should throw error when url is not provided', async () => {
+    const { setupTracing } = await import('./index.mjs');
+    assert.throws(() => {
+      setupTracing({ serviceName: 'test-service' });
+    }, /url is required/);
+  });
+
+  it('should create a tracer with required parameters', async () => {
+    const { setupTracing } = await import('./index.mjs');
+    const tracer = setupTracing({
       serviceName: 'test-service',
-      url: null,
+      url: 'http://localhost:4317',
     });
-    expect(tracer).toBeDefined();
+    assert.ok(tracer, 'tracer should be defined');
   });
 
-  it('should create a tracer with custom application name and endpoint', () => {
-    const tracer = setupTracing('test-service', 'custom-app', 'custom-endpoint');
-    expect(NodeTracerProvider).toHaveBeenCalledTimes(1);
-    expect(BatchSpanProcessor).toHaveBeenCalledTimes(1);
-    expect(OTLPTraceExporter).toHaveBeenCalledWith({
+  it('should accept hostname parameter', async () => {
+    const { setupTracing } = await import('./index.mjs');
+    const tracer = setupTracing({
       serviceName: 'test-service',
-      url: 'custom-endpoint',
+      url: 'http://localhost:4317',
+      hostname: 'test-host',
     });
-    expect(tracer).toBeDefined();
+    assert.ok(tracer, 'tracer should be defined');
   });
 
+  it('should accept optional instrumentations', async () => {
+    const { setupTracing } = await import('./index.mjs');
+    const tracer = setupTracing({
+      serviceName: 'test-service',
+      url: 'http://localhost:4317',
+      enableFsInstrumentation: true,
+      enableDnsInstrumentation: true,
+    });
+    assert.ok(tracer, 'tracer should be defined');
+  });
 });

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "3.13.4",
+  "version": "3.13.6",
   "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.mjs",
+    "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",
     "lint": "eslint .",
     "rebuild": "rm -rfv node_modules/ package-lock.json && npm install --prod --omit=dev"
   },
@@ -32,16 +32,16 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/context-async-hooks": "^2.0.1",
-    "@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.57.0",
-    "@opentelemetry/instrumentation-pino": "^0.55.0",
+    "@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-http": "^0.213.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.60.0",
+    "@opentelemetry/instrumentation-pino": "^0.58.0",
     "@opentelemetry/resources": "^2.0.1",
     "@opentelemetry/sdk-trace-base": "^2.0.0",
     "@opentelemetry/sdk-trace-node": "^2.0.0",