Merge branch 'fix/otel-dupe-knex' into feat/kanon-request-metrics

Author: kschelonka

.env.local.example

@@ -69,3 +69,5 @@ PUBSUB_EMULATOR_HOST=localhost:8085
 OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
 OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
 OTEL_SERVICE_NAME=monitor
+OTEL_NODE_ENABLED_INSTRUMENTATIONS="http,knex,fs,grpc,aws-sdk,ioredis,winston,undici,runtime-node,redis"
+OTEL_RESOURCE_ATTRIBUTES="service.namespace=monitor-local,service.version=0.0.1"

src/instrumentation.node.ts

@@ -10,7 +10,11 @@ import {
   ConsoleMetricExporter,
   PeriodicExportingMetricReader,
 } from "@opentelemetry/sdk-metrics";
-import { resourceFromAttributes } from "@opentelemetry/resources";
+import {
+  envDetector,
+  processDetector,
+  resourceFromAttributes,
+} from "@opentelemetry/resources";
 import { NodeSDK } from "@opentelemetry/sdk-node";
 import {
   AlwaysOnSampler,
@@ -19,7 +23,6 @@ import {
   ParentBasedSampler,
   SimpleSpanProcessor,
 } from "@opentelemetry/sdk-trace-node";
-import { KnexInstrumentation } from "@opentelemetry/instrumentation-knex";
 import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
@@ -56,6 +59,15 @@ export async function nodeSDKBuilder() {
 
   const sentryClient = Sentry.getClient();
 
+  // All required resources are injected through env vars
+  // in cloud deployment, but locally we can use detectors
+  // The host detector has a known issue with async attributes
+  // and isn't super important
+  // https://github.com/open-telemetry/opentelemetry-js/issues/4638
+  const resourceDetectors = isLocalCollector
+    ? [processDetector, envDetector]
+    : undefined;
+
   if (sentryClient) {
     // https://github.com/getsentry/sentry-javascript/tree/develop/packages/opentelemetry
     setupEventContextTrace(sentryClient);
@@ -92,7 +104,6 @@ export async function nodeSDKBuilder() {
   const sdk = new NodeSDK({
     resource: resourceFromAttributes({
       [ATTR_SERVICE_NAME]: appConfig.otel.serviceName,
-      ...appConfig.otel.resourceAttributes,
     }),
     metricReaders: [
       new PeriodicExportingMetricReader({
@@ -113,17 +124,17 @@ export async function nodeSDKBuilder() {
     // Ensure the correct subset of traces is sent to Sentry
     // This also ensures trace propagation works as expected
     sampler,
+    // Kuberenetes infrastructure automatically injects
+    // required resources through environment variables
+    autoDetectResources: isLocalCollector ? true : false,
+    resourceDetectors,
     instrumentations: [
       getNodeAutoInstrumentations({
         "@opentelemetry/instrumentation-fs": {
           // Disable unless required by parent span (noisy and memory-intensive)
           enabled: false,
           requireParentSpan: true,
         },
-        "@opentelemetry/instrumentation-pg": {
-          // Disable because we're using @opentelemetry/instrumentation-knex
-          enabled: false,
-        },
         // Node native fetch instrumentation
         "@opentelemetry/instrumentation-undici": {
           // Ignore sending anonymous telemetry to next.js
@@ -146,13 +157,7 @@ export async function nodeSDKBuilder() {
             return false;
           },
         },
-        // Similar to prometheus default metrics
-        "@opentelemetry/instrumentation-runtime-node": {
-          enabled: true,
-        },
       }),
-      // Additional instrumentations
-      new KnexInstrumentation(),
     ],
   });
   sdk.start();