@vizydrop/tracer 3.5.1 → 4.0.0

package/README.md

@@ -0,0 +1,113 @@
+# @vizydrop/tracer
+
+OpenTelemetry tracing wrapper for Vizydrop/Targetprocess Node.js services. Provides auto-instrumentation, metric collection, and correlation ID capture middleware for Express and Koa.
+
+## Installation
+
+```bash
+yarn add @vizydrop/tracer
+```
+
+## Usage
+
+### Basic Setup
+
+```ts
+import {createTracer} from '@vizydrop/tracer';
+
+const {trace, agent} = createTracer({
+    openTelemetryOptions: {
+        serviceName: 'my-service',
+        serviceVersion: '1.0.0',
+        clusterName: 'production',
+        environment: 'prod',
+    },
+});
+
+// Use trace API for manual spans
+const tracer = trace.getTracer('my-module');
+
+// Graceful shutdown
+process.on('SIGTERM', () => agent.shutdown());
+```
+
+### Express Middleware
+
+Captures correlation ID from the request and attaches it to the active OpenTelemetry span.
+
+```ts
+import {express} from '@vizydrop/tracer';
+
+app.use(express.captureCorrelationIdMiddleware((req) => req.headers['x-correlation-id']));
+```
+
+### Koa Middleware
+
+```ts
+import {koa} from '@vizydrop/tracer';
+
+app.use(koa.captureCorrelationIdMiddleware((request) => request.headers['x-correlation-id']));
+```
+
+## Configuration
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `enabled` | `boolean` | `true` | Enable/disable tracing instrumentation |
+| `serviceName` | `string` | — | Service name reported to the collector |
+| `serviceVersion` | `string` | — | Service version reported to the collector |
+| `clusterName` | `string` | — | Cluster name (custom `tp_cluster` attribute) |
+| `environment` | `string` | — | Deployment environment |
+| `metricsIntervalMillis` | `number` | `1000` | Metric export interval in milliseconds |
+| `ignoreUrls` | `(string \| RegExp)[]` | See below | URLs to exclude from tracing |
+| `flushToConsole` | `boolean` | `false` | Output traces/metrics to console instead of OTLP |
+| `traceExporterOptions` | `object` | — | Options passed to `OTLPTraceExporter` |
+| `metricExporterOptions` | `object` | — | Options passed to `OTLPMetricExporter` |
+| `getSpanAttributes` | `() => Record<string, string \| undefined>` | — | Function that returns custom attributes to attach to every span on start. Useful for injecting context like correlation IDs or user metadata from CLS/async storage into all outgoing spans. |
+
+### Default Ignored URLs
+
+- `/metrics`, `/_prometheus/metrics`
+- `/assets/*`
+- `/favicon*`
+- `/api/v1/status`
+- `/status`
+
+## Features
+
+- Automatic HTTP instrumentation via `@opentelemetry/auto-instrumentations-node`
+- Sensitive data stripping from span names (tokens, session IDs, secrets)
+- OTLP/gRPC export for traces and metrics
+- Console export mode for local development
+- Correlation ID capture middleware for Express and Koa
+- Custom span attributes via `getSpanAttributes` (e.g., inject correlation IDs from async context)
+
+### Custom Span Attributes
+
+Use `getSpanAttributes` to inject dynamic attributes (e.g., correlation ID from CLS) into every span:
+
+```ts
+import {createTracer} from '@vizydrop/tracer';
+import {correlationId} from '@vizydrop/correlation-id';
+
+const {trace, agent} = createTracer({
+    openTelemetryOptions: {
+        serviceName: 'my-service',
+        getSpanAttributes: () => ({
+            'correlation.id': correlationId.getId(),
+            'user.email': correlationId.getMetadata()?.email,
+        }),
+    },
+});
+```
+
+## Development
+
+```bash
+yarn install
+yarn build       # Compile TypeScript
+yarn test        # Run tests
+yarn lint        # Run ESLint
+```
+
+

package/dist/BaggageSpanProcessor.d.ts

@@ -0,0 +1,16 @@
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+import type { SpanProcessor, Span } from '@opentelemetry/sdk-trace-node';
+export type GetSpanAttributes = () => Record<string, string | undefined>;
+declare class BaggageSpanProcessor implements SpanProcessor {
+    private readonly getAttributes;
+    private static readonly RESOLVED;
+    constructor(getAttributes: GetSpanAttributes);
+    onStart(span: Span): void;
+    onEnd(): void;
+    forceFlush(): Promise<void>;
+    shutdown(): Promise<void>;
+}
+export { BaggageSpanProcessor };
+//# sourceMappingURL=BaggageSpanProcessor.d.ts.map

package/dist/BaggageSpanProcessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaggageSpanProcessor.d.ts","sourceRoot":"","sources":["../src/BaggageSpanProcessor.ts"],"names":[],"mappings":"AAAA;;uEAEuE;AACvE,OAAO,KAAK,EAAC,aAAa,EAAE,IAAI,EAAC,MAAM,+BAA+B,CAAC;AAEvE,MAAM,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;AAEzE,cAAM,oBAAqB,YAAW,aAAa;IAGnC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAF1C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAqB;gBAExB,aAAa,EAAE,iBAAiB;IAI7D,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAQzB,KAAK,IAAI,IAAI;IAEb,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B;AAED,OAAO,EAAC,oBAAoB,EAAC,CAAC"}

package/dist/BaggageSpanProcessor.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaggageSpanProcessor = void 0;
+class BaggageSpanProcessor {
+    constructor(getAttributes) {
+        this.getAttributes = getAttributes;
+        this.getAttributes = getAttributes;
+    }
+    onStart(span) {
+        try {
+            span.setAttributes(this.getAttributes());
+        }
+        catch {
+            // Do not drop the span if attribute extraction fails
+        }
+    }
+    onEnd() { }
+    forceFlush() {
+        return BaggageSpanProcessor.RESOLVED;
+    }
+    shutdown() {
+        return BaggageSpanProcessor.RESOLVED;
+    }
+}
+exports.BaggageSpanProcessor = BaggageSpanProcessor;
+BaggageSpanProcessor.RESOLVED = Promise.resolve();
+//# sourceMappingURL=BaggageSpanProcessor.js.map

package/dist/BaggageSpanProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaggageSpanProcessor.js","sourceRoot":"","sources":["../src/BaggageSpanProcessor.ts"],"names":[],"mappings":";;;AAOA,MAAM,oBAAoB;IAGtB,YAA6B,aAAgC;QAAhC,kBAAa,GAAb,aAAa,CAAmB;QACzD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;IAED,OAAO,CAAC,IAAU;QACd,IAAI,CAAC;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAC7C,CAAC;QAAC,MAAM,CAAC;YACL,qDAAqD;QACzD,CAAC;IACL,CAAC;IAED,KAAK,KAAU,CAAC;IAEhB,UAAU;QACN,OAAO,oBAAoB,CAAC,QAAQ,CAAC;IACzC,CAAC;IAED,QAAQ;QACJ,OAAO,oBAAoB,CAAC,QAAQ,CAAC;IACzC,CAAC;;AAGG,oDAAoB;AAzBA,6BAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC"}

package/dist/defaultOptions.d.ts

@@ -0,0 +1,7 @@
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+import type { DefaultOptions, OpenTelemetryOptions } from './types';
+declare const addDefaultOptions: (overrides: OpenTelemetryOptions) => DefaultOptions & OpenTelemetryOptions;
+export { addDefaultOptions, };
+//# sourceMappingURL=defaultOptions.d.ts.map

package/dist/defaultOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultOptions.d.ts","sourceRoot":"","sources":["../src/defaultOptions.ts"],"names":[],"mappings":"AAAA;;uEAEuE;AACvE,OAAO,KAAK,EAAC,cAAc,EAAE,oBAAoB,EAAC,MAAM,SAAS,CAAC;AAclE,QAAA,MAAM,iBAAiB,GAAI,WAAW,oBAAoB,KAAG,cAAc,GAAG,oBAG5E,CAAC;AAEH,OAAO,EACH,iBAAiB,GACpB,CAAC"}

package/{src → dist}/defaultOptions.js

@@ -1,6 +1,6 @@
-/*********************************************************************
-* © Copyright IBM Corp. 2025
-*********************************************************************/
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addDefaultOptions = void 0;
 const defaultOptions = {
     enabled: true,
     metricsIntervalMillis: 1000,
@@ -10,12 +10,11 @@ const defaultOptions = {
         /\/favicon.*/,
         '/api/v1/status',
         /[a-z ]*\/status/,
-    ]
+    ],
 };
-
-const addDefaultOptions = overrides => ({
+const addDefaultOptions = (overrides) => ({
     ...defaultOptions,
     ...overrides,
 });
-
-module.exports =  { addDefaultOptions };
+exports.addDefaultOptions = addDefaultOptions;
+//# sourceMappingURL=defaultOptions.js.map

package/dist/defaultOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultOptions.js","sourceRoot":"","sources":["../src/defaultOptions.ts"],"names":[],"mappings":";;;AAKA,MAAM,cAAc,GAAmB;IACnC,OAAO,EAAE,IAAI;IACb,qBAAqB,EAAE,IAAI;IAC3B,UAAU,EAAE;QACR,kDAAkD;QAClD,cAAc;QACd,aAAa;QACb,gBAAgB;QAChB,iBAAiB;KACpB;CACJ,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,SAA+B,EAAyC,EAAE,CAAC,CAAC;IACnG,GAAG,cAAc;IACjB,GAAG,SAAS;CACf,CAAC,CAAC;AAGC,8CAAiB"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+import { createTracer } from './tracer';
+export { createTracer, };
+export type { OpenTelemetryOptions, CreateTracerOptions, TracerInstance } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;uEAEuE;AACvE,OAAO,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AAEtC,OAAO,EACH,YAAY,GACf,CAAC;AAEF,YAAY,EACR,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACjB,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTracer = void 0;
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+const tracer_1 = require("./tracer");
+Object.defineProperty(exports, "createTracer", { enumerable: true, get: function () { return tracer_1.createTracer; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA;;uEAEuE;AACvE,qCAAsC;AAGlC,6FAHI,qBAAY,OAGJ"}

package/dist/requestFilters.d.ts

@@ -0,0 +1,7 @@
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+declare function replaceSensitiveData(text: string | undefined): string | undefined;
+declare const buildIgnoredUrlMatcher: (ignoreUrls: (string | RegExp)[]) => (url: string) => boolean;
+export { replaceSensitiveData, buildIgnoredUrlMatcher, };
+//# sourceMappingURL=requestFilters.d.ts.map

package/dist/requestFilters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestFilters.d.ts","sourceRoot":"","sources":["../src/requestFilters.ts"],"names":[],"mappings":"AAAA;;uEAEuE;AAEvE,iBAAS,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAwB1E;AAED,QAAA,MAAM,sBAAsB,GAAI,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,MAC1D,KAAK,MAAM,KAAG,OAA2D,CAAC;AAE/E,OAAO,EACH,oBAAoB,EACpB,sBAAsB,GACzB,CAAC"}

package/dist/requestFilters.js

@@ -0,0 +1,28 @@
+"use strict";
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildIgnoredUrlMatcher = void 0;
+exports.replaceSensitiveData = replaceSensitiveData;
+function replaceSensitiveData(text) {
+    if (!text) {
+        return text;
+    }
+    const sensitivePatterns = [
+        /token=([^&]*)/gi,
+        /reset-password\/(?:.*)\/(.*)/gi,
+        /sessionId=([^&]*)/g,
+        /secret=([^&]*)/gi,
+    ];
+    return sensitivePatterns.reduce((result, regexp) => {
+        const matches = regexp.exec(result);
+        if (matches) {
+            return matches.slice(1).reduce((res, match) => res.replace(match, '********'), result);
+        }
+        return result;
+    }, text);
+}
+const buildIgnoredUrlMatcher = (ignoreUrls) => (url) => ignoreUrls.some((ignored) => url.match(ignored));
+exports.buildIgnoredUrlMatcher = buildIgnoredUrlMatcher;
+//# sourceMappingURL=requestFilters.js.map

package/dist/requestFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestFilters.js","sourceRoot":"","sources":["../src/requestFilters.ts"],"names":[],"mappings":";AAAA;;uEAEuE;;;AAgCnE,oDAAoB;AA9BxB,SAAS,oBAAoB,CAAC,IAAwB;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,iBAAiB,GAAG;QACtB,iBAAiB;QACjB,gCAAgC;QAChC,oBAAoB;QACpB,kBAAkB;KACrB,CAAC;IAEF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;QAC/C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEpC,IAAI,OAAO,EAAE,CAAC;YACV,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAC1B,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,EAC9C,MAAM,CACT,CAAC;QACN,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAED,MAAM,sBAAsB,GAAG,CAAC,UAA+B,EAAE,EAAE,CAC/D,CAAC,GAAW,EAAW,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AAI3E,wDAAsB"}

package/dist/tracer.d.ts

@@ -0,0 +1,4 @@
+import type { CreateTracerOptions, CreateTracerResult } from './types';
+declare function createTracer({ openTelemetryOptions }: CreateTracerOptions): CreateTracerResult;
+export { createTracer, };
+//# sourceMappingURL=tracer.d.ts.map

package/dist/tracer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracer.d.ts","sourceRoot":"","sources":["../src/tracer.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAiB,mBAAmB,EAAE,kBAAkB,EAAuC,MAAM,SAAS,CAAC;AA8E3H,iBAAS,YAAY,CAAC,EAAC,oBAAoB,EAAC,EAAE,mBAAmB,GAAG,kBAAkB,CAQrF;AAED,OAAO,EACH,YAAY,GACf,CAAC"}

package/dist/tracer.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTracer = createTracer;
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+const api_1 = require("@opentelemetry/api");
+const sdk_node_1 = require("@opentelemetry/sdk-node");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const resources_1 = require("@opentelemetry/resources");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const auto_instrumentations_node_1 = require("@opentelemetry/auto-instrumentations-node");
+const exporter_trace_otlp_grpc_1 = require("@opentelemetry/exporter-trace-otlp-grpc");
+const exporter_metrics_otlp_grpc_1 = require("@opentelemetry/exporter-metrics-otlp-grpc");
+const sdk_metrics_1 = require("@opentelemetry/sdk-metrics");
+const requestFilters_1 = require("./requestFilters");
+const defaultOptions_1 = require("./defaultOptions");
+const BaggageSpanProcessor_1 = require("./BaggageSpanProcessor");
+const ResourceAttributes = {
+    TpClusterName: 'tp_cluster',
+    DatadogEnvironment: 'tags.datadoghq.com/env',
+    Environment: 'deployment.environment',
+};
+const createOpenTelemetryAgent = ({ enabled, serviceName, serviceVersion, clusterName, environment, metricsIntervalMillis, ignoreUrls, flushToConsole, traceExporterOptions, metricExporterOptions, getSpanAttributes, }) => {
+    const matchIgnoredUrl = (0, requestFilters_1.buildIgnoredUrlMatcher)(ignoreUrls);
+    const traceExporter = flushToConsole
+        ? new sdk_trace_node_1.ConsoleSpanExporter()
+        : new exporter_trace_otlp_grpc_1.OTLPTraceExporter(traceExporterOptions);
+    const metricReader = flushToConsole
+        ? new sdk_metrics_1.PeriodicExportingMetricReader({
+            exporter: new sdk_metrics_1.ConsoleMetricExporter(),
+            exportIntervalMillis: metricsIntervalMillis,
+        })
+        : new sdk_metrics_1.PeriodicExportingMetricReader({ exporter: new exporter_metrics_otlp_grpc_1.OTLPMetricExporter(metricExporterOptions) });
+    const spanProcessors = getSpanAttributes
+        ? [new BaggageSpanProcessor_1.BaggageSpanProcessor(getSpanAttributes), new sdk_trace_node_1.BatchSpanProcessor(traceExporter)]
+        : [new sdk_trace_node_1.BatchSpanProcessor(traceExporter)];
+    const agent = new sdk_node_1.NodeSDK({
+        resource: (0, resources_1.resourceFromAttributes)({
+            [semantic_conventions_1.ATTR_SERVICE_NAME]: serviceName,
+            [semantic_conventions_1.ATTR_SERVICE_VERSION]: serviceVersion,
+            [ResourceAttributes.TpClusterName]: clusterName,
+            [ResourceAttributes.DatadogEnvironment]: environment,
+            [ResourceAttributes.Environment]: environment,
+        }),
+        metricReader,
+        spanProcessors,
+        instrumentations: enabled
+            ? [
+                (0, auto_instrumentations_node_1.getNodeAutoInstrumentations)({
+                    '@opentelemetry/instrumentation-http': {
+                        ignoreIncomingRequestHook: ({ url }) => matchIgnoredUrl(url ?? ''),
+                        ignoreOutgoingRequestHook: ({ path }) => matchIgnoredUrl(path ?? ''),
+                        requestHook: (span, request) => {
+                            if (span) {
+                                const url = request.url;
+                                span.updateName((0, requestFilters_1.replaceSensitiveData)(url) ?? '');
+                            }
+                        },
+                    },
+                }),
+            ]
+            : [],
+    });
+    if (enabled) {
+        agent.start();
+    }
+    return {
+        shutdown: () => agent.shutdown(),
+    };
+};
+function createTracer({ openTelemetryOptions }) {
+    const config = (0, defaultOptions_1.addDefaultOptions)(openTelemetryOptions);
+    const agent = createOpenTelemetryAgent(config);
+    return {
+        trace: api_1.trace,
+        agent,
+    };
+}
+//# sourceMappingURL=tracer.js.map

package/dist/tracer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracer.js","sourceRoot":"","sources":["../src/tracer.ts"],"names":[],"mappings":";;AAqGI,oCAAY;AArGhB;;uEAEuE;AACvE,4CAAyC;AACzC,sDAAgD;AAChD,kEAAsF;AACtF,wDAAgE;AAChE,8EAA4F;AAC5F,0FAAsF;AACtF,sFAA0E;AAC1E,0FAA6E;AAC7E,4DAAgG;AAEhG,qDAA8E;AAC9E,qDAAmD;AACnD,iEAA4D;AAE5D,MAAM,kBAAkB,GAAG;IACvB,aAAa,EAAE,YAAY;IAC3B,kBAAkB,EAAE,wBAAwB;IAC5C,WAAW,EAAE,wBAAwB;CAC/B,CAAC;AAEX,MAAM,wBAAwB,GAAG,CAAC,EAC9B,OAAO,EACP,WAAW,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,GACmB,EAAkB,EAAE;IACxD,MAAM,eAAe,GAAG,IAAA,uCAAsB,EAAC,UAAU,CAAC,CAAC;IAC3D,MAAM,aAAa,GAAG,cAAc;QAChC,CAAC,CAAC,IAAI,oCAAmB,EAAE;QAC3B,CAAC,CAAC,IAAI,4CAAiB,CAAC,oBAAoB,CAAC,CAAC;IAClD,MAAM,YAAY,GAAG,cAAc;QAC/B,CAAC,CAAC,IAAI,2CAA6B,CAAC;YAC9B,QAAQ,EAAE,IAAI,mCAAqB,EAAE;YACrC,oBAAoB,EAAE,qBAAqB;SAC9C,CAAC;QACJ,CAAC,CAAC,IAAI,2CAA6B,CAAC,EAAC,QAAQ,EAAE,IAAI,+CAAkB,CAAC,qBAAqB,CAAC,EAAC,CAAC,CAAC;IAEnG,MAAM,cAAc,GAAG,iBAAiB;QACpC,CAAC,CAAC,CAAC,IAAI,2CAAoB,CAAC,iBAAiB,CAAC,EAAE,IAAI,mCAAkB,CAAC,aAAa,CAAC,CAAC;QACtF,CAAC,CAAC,CAAC,IAAI,mCAAkB,CAAC,aAAa,CAAC,CAAC,CAAC;IAE9C,MAAM,KAAK,GAAG,IAAI,kBAAO,CAAC;QACtB,QAAQ,EAAE,IAAA,kCAAsB,EAAC;YAC7B,CAAC,wCAAiB,CAAC,EAAE,WAAW;YAChC,CAAC,2CAAoB,CAAC,EAAE,cAAc;YACtC,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE,WAAW;YAC/C,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,WAAW;YACpD,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,WAAW;SAChD,CAAC;QACF,YAAY;QACZ,cAAc;QACd,gBAAgB,EAAE,OAAO;YACrB,CAAC,CAAC;gBACI,IAAA,wDAA2B,EAAC;oBACxB,qCAAqC,EAAE;wBACnC,yBAAyB,EAAE,CAAC,EAAC,GAAG,EAAiB,EAAE,EAAE,CACjD,eAAe,CAAC,GAAG,IAAI,EAAE,CAAC;wBAC9B,yBAAyB,EAAE,CAAC,EAAC,IAAI,EAAyB,EAAE,EAAE,CAC1D,eAAe,CAAC,IAAI,IAAI,EAAE,CAAC;wBAC/B,WAAW,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;4BAC3B,IAAI,IAAI,EAAE,CAAC;gCACP,MAAM,GAAG,GAAI,OAA0B,CAAC,GAAG,CAAC;gCAC5C,IAAI,CAAC,UAAU,CAAC,IAAA,qCAAoB,EAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;4BACrD,CAAC;wBACL,CAAC;qBACJ;iBACJ,CAAC;aACL;YACH,CAAC,CAAC,EAAE;KACX,CAAC,CAAC;IAEH,IAAI,OAAO,EAAE,CAAC;QACV,KAAK,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC;IAED,OAAO;QACH,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE;KACnC,CAAC;AACN,CAAC,CAAC;AAEF,SAAS,YAAY,CAAC,EAAC,oBAAoB,EAAsB;IAC7D,MAAM,MAAM,GAAG,IAAA,kCAAiB,EAAC,oBAAoB,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAE/C,OAAO;QACH,KAAK,EAAL,WAAK;QACL,KAAK;KACR,CAAC;AACN,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+export { DefaultOptions } from './options';
+export { OpenTelemetryOptions, CreateTracerOptions, CreateTracerResult, TracerInstance } from './tracer';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;uEAEuE;AACvE,OAAO,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AACzC,OAAO,EAAC,oBAAoB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,cAAc,EAAC,MAAM,UAAU,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/dist/types/options.d.ts

@@ -0,0 +1,9 @@
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+export interface DefaultOptions {
+    enabled: boolean;
+    metricsIntervalMillis: number;
+    ignoreUrls: (string | RegExp)[];
+}
+//# sourceMappingURL=options.d.ts.map

package/dist/types/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/types/options.ts"],"names":[],"mappings":"AAAA;;uEAEuE;AACvE,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,UAAU,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CACnC"}

package/dist/types/options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=options.js.map

package/dist/types/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/types/options.ts"],"names":[],"mappings":""}

package/dist/types/tracer.d.ts

@@ -0,0 +1,28 @@
+/*********************************************************************
+ * © Copyright IBM Corp. 2026
+ *********************************************************************/
+import type { TraceAPI } from '@opentelemetry/api';
+export interface OpenTelemetryOptions {
+    enabled?: boolean;
+    serviceName?: string;
+    serviceVersion?: string;
+    clusterName?: string;
+    environment?: string;
+    metricsIntervalMillis?: number;
+    ignoreUrls?: (string | RegExp)[];
+    flushToConsole?: boolean;
+    traceExporterOptions?: Record<string, unknown>;
+    metricExporterOptions?: Record<string, unknown>;
+    getSpanAttributes?: () => Record<string, string | undefined>;
+}
+export interface TracerInstance {
+    shutdown: () => Promise<void>;
+}
+export interface CreateTracerOptions {
+    openTelemetryOptions: OpenTelemetryOptions;
+}
+export interface CreateTracerResult {
+    trace: TraceAPI;
+    agent: TracerInstance;
+}
+//# sourceMappingURL=tracer.d.ts.map

package/dist/types/tracer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracer.d.ts","sourceRoot":"","sources":["../../src/types/tracer.ts"],"names":[],"mappings":"AAAA;;uEAEuE;AACvE,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,oBAAoB,CAAC;AAEjD,MAAM,WAAW,oBAAoB;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,UAAU,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACjC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/C,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChD,iBAAiB,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;CAChE;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAChC,oBAAoB,EAAE,oBAAoB,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,QAAQ,CAAC;IAChB,KAAK,EAAE,cAAc,CAAC;CACzB"}

package/dist/types/tracer.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tracer.js.map

package/dist/types/tracer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracer.js","sourceRoot":"","sources":["../../src/types/tracer.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,46 +1,64 @@
 {
   "name": "@vizydrop/tracer",
   "license": "MIT",
-  "version": "3.5.1",
+  "version": "4.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "yarn build",
     "test": "jest",
-    "lint": "eslint --quiet ."
+    "lint": "eslint --quiet --ext .ts src/"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.55.3",
-    "@opentelemetry/exporter-metrics-otlp-grpc": "^0.207.0",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.207.0",
-    "@opentelemetry/resources": "^2.2.0",
-    "@opentelemetry/sdk-metrics": "^2.2.0",
-    "@opentelemetry/sdk-node": "^0.207.0",
-    "@opentelemetry/sdk-trace-node": "^2.2.0",
-    "@opentelemetry/semantic-conventions": "^1.37.0",
-    "lodash": "^4.17.23"
+    "@opentelemetry/auto-instrumentations-node": "^0.76.0",
+    "@opentelemetry/exporter-metrics-otlp-grpc": "^0.218.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.218.0",
+    "@opentelemetry/resources": "^2.7.1",
+    "@opentelemetry/sdk-metrics": "^2.7.1",
+    "@opentelemetry/sdk-node": "^0.218.0",
+    "@opentelemetry/sdk-trace-node": "^2.7.1",
+    "@opentelemetry/semantic-conventions": "^1.41.1"
   },
   "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
     "@vizydrop/eslint-config-vizydrop": "7.2.3",
-    "eslint": "6.8.0",
+    "eslint": "^8.56.0",
     "eslint-config-airbnb": "18.1.0",
     "eslint-config-prettier": "6.10.0",
     "eslint-plugin-babel": "5.3.0",
     "eslint-plugin-filenames": "1.3.2",
     "eslint-plugin-flowtype": "4.7.0",
-    "eslint-plugin-import": "2.22.1",
+    "eslint-plugin-import": "2.29.1",
     "eslint-plugin-jsx-a11y": "6.2.3",
-    "eslint-plugin-lodash-fp": "2.2.0-a1",
     "eslint-plugin-mocha": "6.3.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "4.2.1",
     "eslint-plugin-react": "7.19.0",
     "eslint-plugin-react-hooks": "2.5.0",
-    "jest": "30.2.0"
+    "jest": "30.2.0",
+    "ts-jest": "^29.3.0",
+    "typescript": "^5.7.0"
   },
   "jest": {
-    "testEnvironment": "node"
-  },
-  "resolutions": {
-    "elastic-apm-node/agentkeepalive/debug": "4.4.3",
-    "elastic-apm-node/require-in-the-middle/debug": "4.4.3"
+    "testEnvironment": "node",
+    "transform": {
+      "^.+\\.ts$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.test.json"
+        }
+      ]
+    },
+    "testMatch": [
+      "**/src/__tests__/**/*.tests.ts"
+    ]
   }
 }

package/.whitesource

@@ -1,8 +0,0 @@
-{
-  "settingsInheritedFrom": "TargetProcess/mend-config@master",
-  "remediateSettings": {
-    "extends": [
-      "github>TargetProcess/mend-config//presets/schedules/fridays"
-    ]
-  }
-}

package/CHANGELOG.md

@@ -1,19 +0,0 @@
-#### v2.4.0
-Disable body capture
-Disable use path as transactions
-
-#### v2.3.1
-Update dependencies
-
-#### v2.3.0
-Disable metrics
-
-#### v2.2.0 
-Do not patch logger if tracer inactive
-
-#### v2.1.0
-Skip OPTIONS requests 
-
-#### v2.0.0
-1. add koa and express middlewares
-2. captureCorrelationIdMiddleware should receive getCorrelationId function

package/index.js

@@ -1,12 +0,0 @@
-/*********************************************************************
-* © Copyright IBM Corp. 2025
-*********************************************************************/
-const {createTracer} = require('./src/tracer');
-const express = require('./src/express');
-const koa = require('./src/koa');
-
-module.exports = {
-    createTracer,
-    express,
-    koa,
-};

package/src/express/captureCorrelationIdMiddleware.js

@@ -1,24 +0,0 @@
-/*********************************************************************
-* © Copyright IBM Corp. 2025
-*********************************************************************/
-const { trace } = require('@opentelemetry/api');
-
-const captureCorrelationIdMiddleware = (getCorrelationId) => {
-    if (!getCorrelationId && typeof getCorrelationId !== 'function') {
-        throw new Error('getCorrelationId expect to be a function');
-    }
-
-    return (req, res, next) => {
-        const currentSpan = trace.getActiveSpan();
-
-        if (currentSpan) {
-            currentSpan.setAttribute('correlationId', getCorrelationId(req));
-        }
-
-        next();
-    };
-};
-
-module.exports = {
-    captureCorrelationIdMiddleware
-};

package/src/express/index.js

@@ -1,8 +0,0 @@
-/*********************************************************************
-* © Copyright IBM Corp. 2025
-*********************************************************************/
-const {captureCorrelationIdMiddleware} = require('./captureCorrelationIdMiddleware');
-
-module.exports = {
-    captureCorrelationIdMiddleware,
-};

package/src/koa/captureCorrelationIdMiddleware.js

@@ -1,24 +0,0 @@
-/*********************************************************************
-* © Copyright IBM Corp. 2025
-*********************************************************************/
-const { trace } = require('@opentelemetry/api');
-
-const captureCorrelationIdMiddleware = (getCorrelationId) => {
-    if (!getCorrelationId && typeof getCorrelationId !== 'function') {
-        throw new Error('getCorrelationId expect to be a function');
-    }
-
-    return async (ctx, next) => {
-        const currentSpan = trace.getActiveSpan();
-
-        if (currentSpan) {
-            currentSpan.setAttribute('correlationId', getCorrelationId(ctx.request));
-        }
-
-        await next();
-    };
-};
-
-module.exports = {
-    captureCorrelationIdMiddleware,
-};

package/src/koa/index.js

@@ -1,8 +0,0 @@
-/*********************************************************************
-* © Copyright IBM Corp. 2025
-*********************************************************************/
-const {captureCorrelationIdMiddleware} = require('./captureCorrelationIdMiddleware');
-
-module.exports = {
-    captureCorrelationIdMiddleware,
-};

package/src/requestFilters.js

@@ -1,37 +0,0 @@
-/*********************************************************************
-* © Copyright IBM Corp. 2025
-*********************************************************************/
-const _ = require('lodash/fp');
-
-function replaceSensitiveData(text) {
-    if (!text) {
-        return text;
-    }
-
-    const sensitivePatterns = [
-        /token=([^&]*)/gi,
-        /reset-password\/(?:.*)\/(.*)/gi,
-        /sessionId=([^&]*)/g,
-        /secret=([^&]*)/gi,
-    ];
-
-    return sensitivePatterns.reduce((result, regexp) => {
-        const matches = regexp.exec(result);
-
-        if (matches) {
-            return _.tail(matches).reduce(
-                (res, match) => res.replace(match, '********'),
-                result,
-            );
-        }
-
-        return result;
-    }, text);
-}
-
-const buildIgnoredUrlMatcher = ignoreUrls => url => ignoreUrls.some(ignored => url.match(ignored));
-
-module.exports = {
-    replaceSensitiveData,
-    buildIgnoredUrlMatcher
-};

package/src/tracer.js

@@ -1,89 +0,0 @@
-/*********************************************************************
-* © Copyright IBM Corp. 2025
-*********************************************************************/
-const { trace } = require('@opentelemetry/api');
-const { NodeSDK } = require('@opentelemetry/sdk-node');
-const { ConsoleSpanExporter } = require('@opentelemetry/sdk-trace-node');
-const { resourceFromAttributes} = require('@opentelemetry/resources');
-const { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } = require('@opentelemetry/semantic-conventions');
-const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
-const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-grpc');
-const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-grpc');
-const { PeriodicExportingMetricReader, ConsoleMetricExporter } = require('@opentelemetry/sdk-metrics');
-const { replaceSensitiveData, buildIgnoredUrlMatcher } = require('./requestFilters');
-const { addDefaultOptions } = require('./defaultOptions');
-
-const ResourceAttributes = {
-    TpClusterName: 'tp_cluster',
-    DatadogEnvironment: 'tags.datadoghq.com/env',
-    Environment: 'deployment.environment'
-};
-
-const createOpenTelemetryAgent = ({
-    enabled,
-    serviceName,
-    serviceVersion,
-    clusterName,
-    environment,
-    metricsIntervalMillis,
-    ignoreUrls,
-    flushToConsole,
-    traceExporterOptions,
-    metricExporterOptions,
-}) => {
-    const matchIgnoredUrl = buildIgnoredUrlMatcher(ignoreUrls);
-    const traceExporter = flushToConsole ?
-        new ConsoleSpanExporter() :
-        new OTLPTraceExporter(traceExporterOptions);
-    const metricReader = flushToConsole ?
-        new PeriodicExportingMetricReader({
-            exporter: new ConsoleMetricExporter(),
-            metricsIntervalMillis
-        }) :
-        new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter(metricExporterOptions) });
-
-    const agent = new NodeSDK({
-        resource: resourceFromAttributes({
-            [ATTR_SERVICE_NAME]: serviceName,
-            [ATTR_SERVICE_VERSION]: serviceVersion,
-            [ResourceAttributes.TpClusterName]: clusterName,
-            [ResourceAttributes.DatadogEnvironment]: environment,
-            [ResourceAttributes.Environment]: environment
-        }),
-        traceExporter,
-        metricReader,
-        instrumentations: enabled ? [
-            getNodeAutoInstrumentations({
-                '@opentelemetry/instrumentation-http': {
-                    ignoreIncomingRequestHook: ({ url })  => matchIgnoredUrl(url),
-                    ignoreOutgoingRequestHook: ({ path })  => matchIgnoredUrl(path),
-                    requestHook: (span, request) => {
-                        if (span) {
-                            span.updateName(replaceSensitiveData(request.url));
-                        }
-                    }
-                }
-            })
-        ] : []
-    });
-
-    if(enabled) {
-        agent.start();
-    }
-    
-    return {
-        shutdown: () => agent.shutdown()
-    };
-};
-
-function createTracer({ openTelemetryOptions }) {
-    const config = addDefaultOptions(openTelemetryOptions);
-    const agent = createOpenTelemetryAgent(config);
-
-    return {
-        trace,
-        agent
-    };
-}
-
-module.exports = {createTracer};