@saidsef/tracing-node 1.8.30 → 1.9.1

package/.eslintrc.yml

@@ -2,7 +2,9 @@ env:
   browser: true
   commonjs: true
   es2021: true
+  jest: true
 extends: eslint:recommended
 parserOptions:
   ecmaVersion: latest
+  sourceType: module
 rules: {}

package/deployment/base/job.yml

@@ -18,7 +18,7 @@ spec:
       - /bin/sh
     args:
       - -c
-      - "npm install && node libs/index.js"
+      - "npm install && node libs/index.mjs"
     resources:
       limits:
         memory: "1Gi"
@@ -31,4 +31,4 @@ spec:
       gitRepo:
         directory: "."
         repository: "https://github.com/saidsef/tracing-node.git"
-        revision: "ins-dns-express-otlp-sdk"
+        revision: "es12-module"

package/libs/{index.js → index.mjs}

@@ -16,31 +16,46 @@
  * limitations under the License.
  */
 
-const { CompositePropagator, W3CBaggagePropagator, W3CTraceContextPropagator } = require('@opentelemetry/core');
-const { registerInstrumentations } = require('@opentelemetry/instrumentation');
-const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
-const { BatchSpanProcessor } = require('@opentelemetry/sdk-trace-base');
-const { OTLPTraceExporter } =  require('@opentelemetry/exporter-trace-otlp-grpc');
-const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
-const { ExpressInstrumentation } = require('@opentelemetry/instrumentation-express');
-const { diag, DiagConsoleLogger, DiagLogLevel } = require('@opentelemetry/api');
-const { Resource } = require('@opentelemetry/resources');
-const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions');
-const { AwsInstrumentation } = require('@opentelemetry/instrumentation-aws-sdk');
-const { PinoInstrumentation } = require('@opentelemetry/instrumentation-pino');
-const { DnsInstrumentation } = require('@opentelemetry/instrumentation-dns');
-const { B3Propagator, B3InjectEncoding } = require('@opentelemetry/propagator-b3');
+import { CompositePropagator, W3CBaggagePropagator, W3CTraceContextPropagator } from '@opentelemetry/core';
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
+import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api';
+import { Resource } from '@opentelemetry/resources';
+import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
+import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';
+import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
+import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';
+import { B3Propagator, B3InjectEncoding } from '@opentelemetry/propagator-b3';
 
 diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO);
 
 /**
-* Sets up tracing for the application with OpenTelemetry.
-* @param {string} serviceName - The name of the service to trace.
-* @param {string} [appName="application"] - The name of the application.
-* @param {string|null} [endpoint=null] - The endpoint for the tracing collector.
-* @returns {NodeTracerProvider} - The NodeTracerProvider instance for the service.
+* Sets up tracing for a given service, allowing for the collection and export of trace data.
+* This function configures a NodeTracerProvider with specific resource attributes, including
+* service name, namespace, and host. It also configures an exporter using the OTLP protocol
+* over gRPC, with the option to specify an endpoint. Instrumentations for HTTP, Express,
+* AWS, Pino, and DNS are registered to capture relevant spans. The function finally returns
+* a tracer specific to the service for initiating and exporting spans.
+*
+* @param {string} serviceName - The name of the service to be traced. This will be used to
+* label traces and is essential for identifying traces belonging
+* to this service.
+* @param {string} [appName="application"] - The namespace or application name the service
+* belongs to. This helps in grouping services under
+* a common namespace for better trace organization.
+* @param {string|null} [endpoint=null] - The endpoint URL for the OTLP gRPC exporter. If not
+* provided, the exporter will default to its standard
+* configuration, which might not be suitable for all
+* deployments.
+* @returns {Tracer} - Returns a Tracer instance configured for the service. This tracer can
+* be used to create and export spans for tracing various operations within
+* the service.
 */
-module.exports.setupTracing = (serviceName, appName="application", endpoint=null) => {
+export const setupTracing = (serviceName, appName="application", endpoint=null) => {
   const provider = new NodeTracerProvider({
     resource: new Resource({
       [SemanticResourceAttributes.SERVICE_NAME]: serviceName,

package/libs/index.test.mjs

@@ -0,0 +1,62 @@
+// 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(),
+}));
+
+describe('setupTracing', () => {
+  beforeEach(() => {
+    // Clear all instances and calls to constructor and all methods:
+    NodeTracerProvider.mockClear();
+    BatchSpanProcessor.mockClear();
+    OTLPTraceExporter.mockClear();
+  });
+
+  it('should create a tracer with default parameters', () => {
+    const tracer = setupTracing('test-service');
+    expect(NodeTracerProvider).toHaveBeenCalledTimes(1);
+    expect(BatchSpanProcessor).toHaveBeenCalledTimes(1);
+    expect(OTLPTraceExporter).toHaveBeenCalledWith({
+      serviceName: 'test-service',
+      url: null,
+    });
+    expect(tracer).toBeDefined();
+  });
+
+  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({
+      serviceName: 'test-service',
+      url: 'custom-endpoint',
+    });
+    expect(tracer).toBeDefined();
+  });
+
+});

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "1.8.30",
+  "version": "1.9.1",
   "description": "tracing NodeJS - This is a wrapper for OpenTelemetry instrumentation packages",
-  "main": "libs/index.js",
+  "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.js",
-    "lint": "eslint libs",
+    "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",
+    "lint": "eslint --ext js,mjs libs",
     "rebuild": "rm -rfv node_modules/ package-lock.json && NODE_ENV=production npm install"
   },
+  "type": "module",
   "private": false,
   "repository": {
     "type": "git",
@@ -29,6 +30,9 @@
   ],
   "author": "Said Sef <saidsef@gmail.com>",
   "license": "Apache-2.0",
+  "engines": {
+    "node": ">= 20"
+  },
   "bugs": {
     "url": "https://github.com/saidsef/tracing-nodejs/issues"
   },
@@ -41,7 +45,7 @@
     "@opentelemetry/instrumentation-dns": "^0.33.0",
     "@opentelemetry/instrumentation-express": "^0.35.0",
     "@opentelemetry/instrumentation-http": "^0.49.1",
-    "@opentelemetry/instrumentation-pino": "^0.35.0",
+    "@opentelemetry/instrumentation-pino": "^0.36.0",
     "@opentelemetry/propagator-b3": "^1.22.0",
     "@opentelemetry/resources": "^1.21.0",
     "@opentelemetry/sdk-trace-base": "^1.22.0",
@@ -50,6 +54,6 @@
   },
   "devDependencies": {
     "eslint": "8.57.0",
-    "sinon": "^17.0.1"
+    "jest": "^29.7.0"
   }
 }

package/libs/index.test.js

@@ -1,44 +0,0 @@
-const assert = require('assert');
-const sinon = require('sinon');
-
-// Mocking OpenTelemetry and its dependencies
-const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
-const { CompositePropagator, W3CBaggagePropagator, W3CTraceContextPropagator } = require('@opentelemetry/core');
-
-const { setupTracing } = require('./index');
-
-// Mocking OpenTelemetry and its dependencies
-sinon.stub(NodeTracerProvider.prototype, 'addSpanProcessor');
-sinon.stub(NodeTracerProvider.prototype, 'register');
-sinon.stub(CompositePropagator.prototype, 'constructor');
-sinon.stub(W3CBaggagePropagator.prototype, 'constructor');
-sinon.stub(W3CTraceContextPropagator.prototype, 'constructor');
-
-// Test case for setupTracing function
-function testSetupTracing() {
-  const serviceName = 'test-service';
-  const tracer = setupTracing(serviceName);
-
-  // Ensure that setupTracing returns a valid tracer
-  assert(tracer, 'Tracer should exist');
-
-  console.log('Setup Tracing test passed successfully');
-}
-
-// Test case for setupTracing function with optional parameters
-function testSetupTracingWithOptionalParams() {
-  const serviceName = 'test-service';
-  const appName = 'test-app';
-  const endpoint = 'https://your-collector-endpoint'; // Provide your collector endpoint here
-
-  const tracer = setupTracing(serviceName, appName, endpoint);
-
-  // Ensure that setupTracing with optional parameters returns a valid tracer
-  assert(tracer, 'Tracer should exist');
-
-  console.log('Setup Tracing with optional params test passed successfully');
-}
-
-// Run the tests
-testSetupTracing();
-testSetupTracingWithOptionalParams();