@vizydrop/tracer 2.6.5 → 3.0.0

package/package.json

@@ -1,13 +1,21 @@
 {
   "name": "@vizydrop/tracer",
   "license": "MIT",
-  "version": "2.6.5",
+  "version": "3.0.0",
   "scripts": {
     "test": "jest",
     "lint": "eslint --quiet ."
   },
   "dependencies": {
-    "elastic-apm-node": "4.9.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.55.3",
+    "@opentelemetry/exporter-metrics-otlp-proto": "^0.57.1",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.57.1",
+    "@opentelemetry/resources": "^1.30.1",
+    "@opentelemetry/sdk-metrics": "^1.30.1",
+    "@opentelemetry/sdk-node": "^0.57.1",
+    "@opentelemetry/sdk-trace-node": "^1.30.1",
+    "@opentelemetry/semantic-conventions": "^1.28.0",
     "lodash": "4.17.21"
   },
   "devDependencies": {

package/src/express/captureCorrelationIdMiddleware.js

@@ -1,14 +1,21 @@
-const captureCorrelationIdMiddleware = (agent, getCorrelationId) => {
+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) => {
-        if (agent) {
-            agent.setLabel(`correlationId`, getCorrelationId(req));
+        const currentSpan = trace.getActiveSpan();
+
+        if (currentSpan) {
+            currentSpan.setAttribute(`correlationId`, getCorrelationId(req));
         }
+
         next();
     };
 };
 
-module.exports = {captureCorrelationIdMiddleware};
+module.exports = {
+    captureCorrelationIdMiddleware
+};

package/src/koa/captureCorrelationIdMiddleware.js

@@ -1,12 +1,17 @@
-const captureCorrelationIdMiddleware = (agent, getCorrelationId) => {
+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) => {
-        if (agent) {
-            agent.setLabel(`correlationId`, getCorrelationId(ctx.request));
+        const currentSpan = trace.getActiveSpan();
+
+        if (currentSpan) {
+            currentSpan.setAttribute(`correlationId`, getCorrelationId(ctx.request));
         }
+
         await next();
     };
 };

package/src/requestFilters.js

@@ -1,11 +1,5 @@
 const _ = require(`lodash/fp`);
 
-function removeNameDoubleSlash(payload) {
-    // eslint-disable-next-line no-param-reassign
-    payload.name = payload.name.replace(/\/\//g, `/`);
-    return payload;
-}
-
 function replaceSensitiveData(text) {
     if (!text) {
         return text;
@@ -32,34 +26,9 @@ function replaceSensitiveData(text) {
     }, text);
 }
 
-function stripSensitiveData(payload) {
-    const urlData = _.get(`context.request.url`, payload);
-    if (urlData) {
-        Object.entries(urlData).forEach(([key, value]) => {
-            urlData[key] = replaceSensitiveData(value);
-        });
-    }
-
-    return payload;
-}
-
-function skipOptionsRequest(payload) {
-    const method = _.get(`context.request.method`, payload);
-    return method === `OPTIONS` ? null : payload;
-}
-
-function requiresRequestType(fn) {
-    return (payload) => {
-        if (payload && payload.type === `request`) {
-            return fn(payload);
-        }
-
-        return payload;
-    };
-}
+const buildIgnoredUrlMatcher = ignoreUrls => url => ignoreUrls.some(ignored => url.match(ignored));
 
 module.exports = {
-    removeNameDoubleSlash: requiresRequestType(removeNameDoubleSlash),
-    stripSensitiveData: requiresRequestType(stripSensitiveData),
-    skipOptionsRequest: requiresRequestType(skipOptionsRequest),
+    replaceSensitiveData,
+    buildIgnoredUrlMatcher
 };

package/src/tracer.js

@@ -1,63 +1,82 @@
-const APM = require(`elastic-apm-node`);
-const requestFilters = require(`./requestFilters`);
+const { trace } = require(`@opentelemetry/api`);
+const { NodeSDK } = require(`@opentelemetry/sdk-node`);
+const { ConsoleSpanExporter } = require(`@opentelemetry/sdk-trace-node`);
+const { Resource } = 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-proto`);
+const { OTLPMetricExporter } = require(`@opentelemetry/exporter-metrics-otlp-proto`);
+const { PeriodicExportingMetricReader, ConsoleMetricExporter } = require(`@opentelemetry/sdk-metrics`);
+const { replaceSensitiveData, buildIgnoredUrlMatcher } = require(`./requestFilters`);
+
+const addDefaultOptions = overrides => ({
+    metricsIntervalMillis: 1000,
+    ignoreUrls: [
+        `/api/v1/status`,
+        /\/assets\/.*/,
+        /\/favicon.*/,
+        `/status`,
+    ],
+    ...overrides,
+});
+
+const createOpenTelemetryAgent = ({
+    serviceName,
+    serviceVersion,
+    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: new Resource({
+            [ATTR_SERVICE_NAME]: serviceName,
+            [ATTR_SERVICE_VERSION]: serviceVersion
+        }),
+        traceExporter,
+        metricReader,
+        instrumentations: [
+            getNodeAutoInstrumentations({
+                '@opentelemetry/instrumentation-http': {
+                    ignoreIncomingRequestHook: ({ url })  => matchIgnoredUrl(url),
+                    ignoreOutgoingRequestHook: ({ path })  => matchIgnoredUrl(path),
+                    requestHook: (span, request) => {
+                        if (span) {
+                            span.updateName(replaceSensitiveData(request.url));
+                        }
+                    }
+                }
+            })
+        ]
+    });
+
+    agent.start();
 
-function createConfig(overrides) {
     return {
-        // metrics
-        metricsInterval: 0,
-        breakdownMetrics: false,
-
-        centralConfig: false,
-
-        // request processing
-        usePathAsTransactionName: false,
-        captureBody: `off`,
-        captureHeaders: false,
-        ignoreUrls: [
-            `/api/v1/status`,
-            /\/assets\/.*/,
-            /\/favicon.*/,
-            `/status`,
-        ],
-
-        // stack traces, erros,
-        errorOnAbortedRequests: false,
-        captureErrorLogStackTraces: false,
-        captureSpanStackTraces: false,
-        stackTraceLimit: 0,
-        captureExceptions: false,
-        logUncaughtExceptions: false,
-
-        active: true,
-
-        // overrides
-        ...overrides,
+        shutdown: () => agent.shutdown()
     };
-}
+};
+
+function createTracer({ openTelemetryOptions }) {
+    const config = addDefaultOptions(openTelemetryOptions);
+    const agent = createOpenTelemetryAgent(config);
 
-function createTracer(opts) {
-    const conf = createConfig(opts);
-
-    const agent = APM.start(conf);
-
-    agent.addFilter(requestFilters.skipOptionsRequest);
-    agent.addFilter(requestFilters.removeNameDoubleSlash);
-    agent.addFilter(requestFilters.stripSensitiveData);
-
-    if (
-        conf.active &&
-        conf.logger &&
-        conf.logger.additionalFields &&
-        typeof conf.logger.additionalFields.add === `function`
-    ) {
-        conf.logger.additionalFields.add({
-            "trace.id": () => agent.currentTraceIds[`trace.id`],
-            "transaction.id": () => agent.currentTraceIds[`transaction.id`],
-            "span.id": () => agent.currentTraceIds[`span.id`],
-        });
-    }
-
-    return agent;
+    return {
+        trace,
+        agent
+    };
 }
 
 module.exports = {createTracer};

package/version.txt

@@ -1 +1 @@
-2.6.5
+3.0.0