@moreapp/common-nodejs 0.5.0 → 0.6.0

package/README.md

@@ -5,3 +5,17 @@ A collection of shared NodeJS code.
 # Pre-commit hooks
 
 Run `yarn prepare` once to install Git hooks, doing lints and prettier formatting
+
+## Usage
+
+### Tracing
+
+Tracing code should always be loaded first, before any other libraries. This is because the OpenTelemetry
+instrumentations monkey patch libraries to add tracing. This will break if the library has been loaded (import/require),
+because the unpatched library will be cached.
+
+Put the following snippet on the first line of the entrypoint file.
+
+```
+require("@moreapp/common-nodejs/dist/tracer").tracer(<service_name>, {});
+```

package/dist/tracer.d.ts

@@ -1,2 +1,8 @@
 import * as types from "@opentelemetry/instrumentation/build/src/types";
-export declare const tracer: (serviceName: string, extraInstrumentations: types.Instrumentation[]) => void;
+export declare const tracer: (serviceName: string, { http, extraInstrumentations, debug, }: {
+    http: {
+        portsToInstrument: number[];
+    };
+    extraInstrumentations: types.Instrumentation[];
+    debug: boolean;
+}) => void;

package/dist/tracer.js

@@ -1,19 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tracer = void 0;
+const api_1 = require("@opentelemetry/api");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
 const opentelemetry_cloud_trace_exporter_1 = require("@google-cloud/opentelemetry-cloud-trace-exporter");
 const instrumentation_1 = require("@opentelemetry/instrumentation");
 const instrumentation_dns_1 = require("@opentelemetry/instrumentation-dns");
 const instrumentation_http_1 = require("@opentelemetry/instrumentation-http");
 const instrumentation_express_1 = require("@opentelemetry/instrumentation-express");
 const instrumentation_winston_1 = require("@opentelemetry/instrumentation-winston");
-const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
 const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
 const resources_1 = require("@opentelemetry/resources");
 const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
 const propagator_b3_1 = require("@opentelemetry/propagator-b3");
 const utils_1 = require("./utils");
-const tracer = (serviceName, extraInstrumentations) => {
+const tracer = (serviceName, { http = {
+    portsToInstrument: [3000],
+}, extraInstrumentations = [], debug = false, }) => {
+    (0, instrumentation_1.registerInstrumentations)({
+        instrumentations: [
+            new instrumentation_dns_1.DnsInstrumentation(),
+            new instrumentation_http_1.HttpInstrumentation({
+                ignoreIncomingRequestHook: (req) => {
+                    return !http.portsToInstrument.includes(req.socket.localPort || 0);
+                },
+            }),
+            new instrumentation_express_1.ExpressInstrumentation(),
+            new instrumentation_winston_1.WinstonInstrumentation(),
+            ...(extraInstrumentations || []),
+        ],
+    });
     const provider = new sdk_trace_node_1.NodeTracerProvider({
         resource: new resources_1.Resource({
             [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName,
@@ -25,25 +41,15 @@ const tracer = (serviceName, extraInstrumentations) => {
             injectEncoding: propagator_b3_1.B3InjectEncoding.MULTI_HEADER,
         }),
     });
-    (0, instrumentation_1.registerInstrumentations)({
-        instrumentations: [
-            new instrumentation_dns_1.DnsInstrumentation(),
-            new instrumentation_http_1.HttpInstrumentation({
-                ignoreIncomingRequestHook: (_req) => {
-                    // Disable instrumentation for incoming requests, handled by ExpressInstrumentation below
-                    return true;
-                },
-            }),
-            new instrumentation_express_1.ExpressInstrumentation(),
-            new instrumentation_winston_1.WinstonInstrumentation(),
-            ...extraInstrumentations,
-        ],
-    });
     if (process.env["STACKDRIVER_TRACING_ENABLED"] === "true") {
         const exporter = new opentelemetry_cloud_trace_exporter_1.TraceExporter({
             resourceFilter: /^service\./,
         });
         provider.addSpanProcessor(new sdk_trace_base_1.BatchSpanProcessor(exporter));
     }
+    if (debug) {
+        api_1.diag.setLogger(new api_1.DiagConsoleLogger(), api_1.DiagLogLevel.DEBUG);
+        provider.addSpanProcessor(new sdk_trace_base_1.BatchSpanProcessor(new sdk_trace_node_1.ConsoleSpanExporter()));
+    }
 };
 exports.tracer = tracer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",