style + fix: move all consts to one file + disable console instrumentation in debug mode (#105)

wrn14897 · web-flow · commit a2ebf6af1350 · 2024-05-09T18:58:56.000Z
diff --git a/.changeset/lovely-panthers-speak.md b/.changeset/lovely-panthers-speak.md
@@ -0,0 +1,5 @@
+---
+'@hyperdx/node-opentelemetry': patch
+---
+
+fix: disable console instrumentation if otel debug mode is on
diff --git a/.changeset/many-trees-jump.md b/.changeset/many-trees-jump.md
@@ -0,0 +1,5 @@
+---
+'@hyperdx/node-opentelemetry': patch
+---
+
+style: move all constants to one file
diff --git a/packages/node-opentelemetry/examples/dummy.js b/packages/node-opentelemetry/examples/dummy.js
@@ -8,7 +8,6 @@ const winston = require('winston');
 const {
   getPinoTransport,
   getWinstonTransport,
-  init,
 } = require('../build/src/logger');
 const { setTraceAttributes } = require('../build/src');
 // const { shutdown } = require('@hyperdx/node-opentelemetry');
@@ -31,7 +30,14 @@ const logger = winston.createLogger({
   ],
 });
 
-const pinoLogger = pino();
+const pinoLogger = pino(
+  pino.transport({
+    targets: [
+      getPinoTransport('info'),
+      // other transports
+    ],
+  }),
+);
 
 async function sendGetRequest() {
   const postData = JSON.stringify({
diff --git a/packages/node-opentelemetry/src/constants.ts b/packages/node-opentelemetry/src/constants.ts
@@ -0,0 +1,37 @@
+import { DiagLogLevel } from '@opentelemetry/api';
+import { defaultServiceName } from '@opentelemetry/resources';
+import { getEnvWithoutDefaults } from '@opentelemetry/core';
+
+import { HDX_DEBUG_MODE_ENABLED } from './debug';
+
+// enable otel debug mode if HDX_DEBUG_MODE_ENABLED is set
+const otelEnv = getEnvWithoutDefaults();
+
+// TO EXTRACT ENV VARS [https://github.com/open-telemetry/opentelemetry-js/blob/3ab4f765d8d696327b7d139ae6a45e7bd7edd924/experimental/packages/sdk-logs/src/export/BatchLogRecordProcessorBase.ts#L50]
+// TO EXTRACT DEFAULTS [https://github.com/open-telemetry/opentelemetry-js/blob/3ab4f765d8d696327b7d139ae6a45e7bd7edd924/experimental/packages/sdk-logs/src/types.ts#L49]
+export const DEFAULT_EXPORTER_BATCH_SIZE =
+  otelEnv.OTEL_BLRP_MAX_EXPORT_BATCH_SIZE ?? 512;
+export const DEFAULT_EXPORTER_TIMEOUT_MS =
+  otelEnv.OTEL_BLRP_EXPORT_TIMEOUT ?? 30000;
+export const DEFAULT_MAX_QUEUE_SIZE = otelEnv.OTEL_BLRP_MAX_QUEUE_SIZE ?? 2048;
+export const DEFAULT_OTEL_TRACES_EXPORTER_URL =
+  otelEnv.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT ??
+  (otelEnv.OTEL_EXPORTER_OTLP_ENDPOINT
+    ? `${otelEnv.OTEL_EXPORTER_OTLP_ENDPOINT}/v1/traces`
+    : 'https://in-otel.hyperdx.io/v1/traces');
+export const DEFAULT_OTEL_LOGS_EXPORTER_URL =
+  otelEnv.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT ??
+  (otelEnv.OTEL_EXPORTER_OTLP_ENDPOINT
+    ? `${otelEnv.OTEL_EXPORTER_OTLP_ENDPOINT}/v1/logs`
+    : 'https://in-otel.hyperdx.io/v1/logs');
+export const DEFAULT_SEND_INTERVAL_MS =
+  otelEnv.OTEL_BLRP_SCHEDULE_DELAY ?? 2000;
+export const DEFAULT_SERVICE_NAME =
+  otelEnv.OTEL_SERVICE_NAME ?? defaultServiceName();
+export const DEFAULT_OTEL_TRACES_SAMPLER =
+  otelEnv.OTEL_TRACES_SAMPLER ?? 'parentbased_always_on';
+export const DEFAULT_OTEL_TRACES_SAMPLER_ARG =
+  otelEnv.OTEL_TRACES_SAMPLER_ARG ?? '1';
+export const DEFAULT_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT =
+  otelEnv.OTEL_EXPORTER_OTLP_TRACES_TIMEOUT ?? 60000;
+export const DEFAULT_OTEL_LOG_LEVEL = otelEnv.OTEL_LOG_LEVEL;
diff --git a/packages/node-opentelemetry/src/instrumentations/console.ts b/packages/node-opentelemetry/src/instrumentations/console.ts
@@ -2,11 +2,11 @@ import * as shimmer from 'shimmer';
 import isObject from 'lodash.isobject';
 import isPlainObject from 'lodash.isplainobject';
 import opentelemetry, { Attributes } from '@opentelemetry/api';
-import { Logger, LoggerOptions } from '../otel-logger';
-import { parseWinstonLog } from '../otel-logger/winston';
 
 import hdx from '../debug';
+import { Logger, LoggerOptions } from '../otel-logger';
 import { hyperDXGlobalContext } from '../context';
+import { parseWinstonLog } from '../otel-logger/winston';
 
 export const _parseConsoleArgs = (args: any[]) => {
   const stringifiedArgs = [];
diff --git a/packages/node-opentelemetry/src/logger.ts b/packages/node-opentelemetry/src/logger.ts
@@ -5,6 +5,7 @@ import HyperDXWinston from './otel-logger/winston';
 import type { HyperDXPinoOptions } from './otel-logger/pino';
 import type { HyperDXWinstonOptions } from './otel-logger/winston';
 
+import { DEFAULT_SERVICE_NAME } from './constants';
 import hdx from './debug';
 import { hyperDXGlobalContext } from './context';
 import { stringToBoolean } from './utils';
@@ -13,8 +14,6 @@ const env = process.env;
 
 const HYPERDX_API_KEY = env.HYPERDX_API_KEY;
 
-const SERVICE_NAME = env.OTEL_SERVICE_NAME as string;
-
 const BETA_MODE = stringToBoolean(env.HDX_NODE_BETA_MODE);
 
 type WinstonTransportOptions = Omit<
@@ -39,9 +38,13 @@ export const getWinstonTransport = (
 ) => {
   hdx('Initializing winston transport');
   return new HyperDXWinston({
-    ...(HYPERDX_API_KEY && { apiKey: HYPERDX_API_KEY }),
+    ...(HYPERDX_API_KEY && {
+      headers: {
+        Authorization: HYPERDX_API_KEY,
+      },
+    }),
     maxLevel,
-    service: SERVICE_NAME,
+    service: DEFAULT_SERVICE_NAME,
     getCustomMeta: BETA_MODE ? getCustomMeta : () => ({}),
     ...options,
   });
@@ -56,8 +59,12 @@ export const getPinoTransport = (
 ) => ({
   target: '@hyperdx/node-opentelemetry/build/src/otel-logger/pino',
   options: {
-    ...(HYPERDX_API_KEY && { apiKey: HYPERDX_API_KEY }),
-    service: SERVICE_NAME,
+    ...(HYPERDX_API_KEY && {
+      headers: {
+        Authorization: HYPERDX_API_KEY,
+      },
+    }),
+    service: DEFAULT_SERVICE_NAME,
     // getCustomMeta, // FIXME: DOMException [DataCloneError]
     ...options,
   },
diff --git a/packages/node-opentelemetry/src/otel-logger/index.ts b/packages/node-opentelemetry/src/otel-logger/index.ts
@@ -1,16 +1,13 @@
 import stringifySafe from 'json-stringify-safe';
-import { Attributes, diag, DiagConsoleLogger } from '@opentelemetry/api';
-import { getEnvWithoutDefaults } from '@opentelemetry/core';
+import { Attributes } from '@opentelemetry/api';
 import {
   BatchLogRecordProcessor,
-  BufferConfig,
   LoggerProvider,
 } from '@opentelemetry/sdk-logs';
+import { Logger as OtelLogger } from '@opentelemetry/api-logs';
 import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http';
-import { Logger as OtelLogger, SeverityNumber } from '@opentelemetry/api-logs';
 import {
   Resource,
-  defaultServiceName,
   detectResourcesSync,
   envDetectorSync,
   hostDetectorSync,
@@ -19,32 +16,17 @@ import {
 } from '@opentelemetry/resources';
 import { SEMRESATTRS_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 
+import {
+  DEFAULT_EXPORTER_BATCH_SIZE,
+  DEFAULT_EXPORTER_TIMEOUT_MS,
+  DEFAULT_MAX_QUEUE_SIZE,
+  DEFAULT_OTEL_LOGS_EXPORTER_URL,
+  DEFAULT_SEND_INTERVAL_MS,
+  DEFAULT_SERVICE_NAME,
+} from '../constants';
 import hdx, { LOG_PREFIX as _LOG_PREFIX } from '../debug';
 import { version as PKG_VERSION } from '../../package.json';
 
-const otelEnv = getEnvWithoutDefaults();
-
-// DEBUG otel modules
-if (otelEnv.OTEL_LOG_LEVEL) {
-  diag.setLogger(new DiagConsoleLogger(), {
-    logLevel: otelEnv.OTEL_LOG_LEVEL,
-  });
-}
-
-// TO EXTRACT ENV VARS [https://github.com/open-telemetry/opentelemetry-js/blob/3ab4f765d8d696327b7d139ae6a45e7bd7edd924/experimental/packages/sdk-logs/src/export/BatchLogRecordProcessorBase.ts#L50]
-// TO EXTRACT DEFAULTS [https://github.com/open-telemetry/opentelemetry-js/blob/3ab4f765d8d696327b7d139ae6a45e7bd7edd924/experimental/packages/sdk-logs/src/types.ts#L49]
-const DEFAULT_EXPORTER_BATCH_SIZE =
-  otelEnv.OTEL_BLRP_MAX_EXPORT_BATCH_SIZE ?? 512;
-const DEFAULT_EXPORTER_TIMEOUT_MS = otelEnv.OTEL_BLRP_EXPORT_TIMEOUT ?? 30000;
-const DEFAULT_MAX_QUEUE_SIZE = otelEnv.OTEL_BLRP_MAX_QUEUE_SIZE ?? 2048;
-const DEFAULT_OTEL_LOGS_EXPORTER_URL =
-  otelEnv.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT ??
-  (otelEnv.OTEL_EXPORTER_OTLP_ENDPOINT
-    ? `${otelEnv.OTEL_EXPORTER_OTLP_ENDPOINT}/v1/logs`
-    : 'https://in-otel.hyperdx.io/v1/logs');
-const DEFAULT_SEND_INTERVAL_MS = otelEnv.OTEL_BLRP_SCHEDULE_DELAY ?? 2000;
-const DEFAULT_SERVICE_NAME = otelEnv.OTEL_SERVICE_NAME ?? defaultServiceName();
-
 const LOG_PREFIX = `⚠️  ${_LOG_PREFIX}`;
 
 export const jsonToString = (json) => {
diff --git a/packages/node-opentelemetry/src/otel.ts b/packages/node-opentelemetry/src/otel.ts
@@ -1,3 +1,4 @@
+import { DiagLogLevel } from '@opentelemetry/api';
 import { InstrumentationBase } from '@opentelemetry/instrumentation';
 import { NodeSDK } from '@opentelemetry/sdk-node';
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
@@ -9,11 +10,17 @@ import {
 
 import HyperDXConsoleInstrumentation from './instrumentations/console';
 import HyperDXSpanProcessor from './spanProcessor';
-import hdx, {
-  HDX_DEBUG_MODE_ENABLED,
-  LOG_PREFIX as _LOG_PREFIX,
-} from './debug';
+import hdx, { LOG_PREFIX as _LOG_PREFIX } from './debug';
 import { getHyperDXHTTPInstrumentationConfig } from './instrumentations/http';
+import {
+  DEFAULT_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT,
+  DEFAULT_OTEL_LOGS_EXPORTER_URL,
+  DEFAULT_OTEL_TRACES_EXPORTER_URL,
+  DEFAULT_OTEL_TRACES_SAMPLER,
+  DEFAULT_OTEL_TRACES_SAMPLER_ARG,
+  DEFAULT_SERVICE_NAME,
+  DEFAULT_OTEL_LOG_LEVEL,
+} from './constants';
 import { hyperDXGlobalContext } from './context';
 import { version as PKG_VERSION } from '../package.json';
 
@@ -32,37 +39,46 @@ export type SDKConfig = {
 
 export const setTraceAttributes = hyperDXGlobalContext.setTraceAttributes;
 
+const setOtelEnvs = () => {
+  // set default otel env vars
+  env.OTEL_NODE_RESOURCE_DETECTORS = env.OTEL_NODE_RESOURCE_DETECTORS ?? 'all';
+  env.OTEL_TRACES_SAMPLER = DEFAULT_OTEL_TRACES_SAMPLER;
+  env.OTEL_TRACES_SAMPLER_ARG = DEFAULT_OTEL_TRACES_SAMPLER_ARG;
+};
+
 let sdk: NodeSDK;
 let hdxConsoleInstrumentation: HyperDXConsoleInstrumentation;
 
 export const initSDK = (config: SDKConfig) => {
-  // enable otel debug mode if HDX_DEBUG_MODE_ENABLED is set
-  if (HDX_DEBUG_MODE_ENABLED) {
-    env.OTEL_LOG_LEVEL = 'debug';
-  }
+  hdx('Setting otel envs');
+  setOtelEnvs();
 
-  // set default otel env vars
-  env.OTEL_EXPORTER_OTLP_ENDPOINT =
-    env.OTEL_EXPORTER_OTLP_ENDPOINT ?? 'https://in-otel.hyperdx.io';
-  env.OTEL_NODE_RESOURCE_DETECTORS = env.OTEL_NODE_RESOURCE_DETECTORS ?? 'all';
-  env.OTEL_LOG_LEVEL = env.OTEL_LOG_LEVEL ?? 'none'; // silence by default
-  env.OTEL_TRACES_SAMPLER = env.OTEL_TRACES_SAMPLER ?? 'parentbased_always_on';
-  env.OTEL_TRACES_SAMPLER_ARG = env.OTEL_TRACES_SAMPLER_ARG ?? '1';
+  const stopOnTerminationSignals = config.stopOnTerminationSignals ?? true; // Stop by default
 
-  // patch OTEL_EXPORTER_OTLP_HEADERS to include API key
+  let exporterHeaders;
   if (env.HYPERDX_API_KEY) {
-    env.OTEL_EXPORTER_OTLP_HEADERS = `${env.OTEL_EXPORTER_OTLP_HEADERS},authorization=${env.HYPERDX_API_KEY}`;
+    exporterHeaders = {
+      Authorization: env.HYPERDX_API_KEY,
+    };
   } else {
     console.warn(`${LOG_PREFIX} HYPERDX_API_KEY is not set`);
   }
 
-  const stopOnTerminationSignals = config.stopOnTerminationSignals ?? true; // Stop by default
-
   hdx('Initializing OpenTelemetry SDK');
-  const consoleInstrumentationEnabled = config.consoleCapture ?? true;
+  let consoleInstrumentationEnabled = config.consoleCapture ?? true;
+  if (DEFAULT_OTEL_LOG_LEVEL === DiagLogLevel.DEBUG) {
+    // FIXME: better to disable console instrumentation if otel log is enabled
+    consoleInstrumentationEnabled = false;
+    console.warn(
+      `${LOG_PREFIX} OTEL_LOG_LEVEL is set to 'debug', disabling console instrumentation`,
+    );
+  }
+
   hdxConsoleInstrumentation = new HyperDXConsoleInstrumentation({
+    baseUrl: DEFAULT_OTEL_LOGS_EXPORTER_URL,
     betaMode: config.betaMode,
-    service: env.OTEL_SERVICE_NAME,
+    service: DEFAULT_SERVICE_NAME,
+    headers: exporterHeaders,
   });
 
   sdk = new NodeSDK({
@@ -76,13 +92,17 @@ export const initSDK = (config: SDKConfig) => {
       ? {
           spanProcessor: new HyperDXSpanProcessor(
             new OTLPTraceExporter({
-              timeoutMillis: 60000,
+              timeoutMillis: DEFAULT_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT,
+              url: DEFAULT_OTEL_TRACES_EXPORTER_URL,
+              headers: exporterHeaders,
             }),
           ) as any,
         }
       : {
           traceExporter: new OTLPTraceExporter({
-            timeoutMillis: 60000,
+            timeoutMillis: DEFAULT_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT,
+            url: DEFAULT_OTEL_TRACES_EXPORTER_URL,
+            headers: exporterHeaders,
           }),
         }),
     instrumentations: [
@@ -109,21 +129,21 @@ export const initSDK = (config: SDKConfig) => {
     ],
   });
 
-  if (env.OTEL_EXPORTER_OTLP_ENDPOINT && env.OTEL_EXPORTER_OTLP_HEADERS) {
+  if (env.OTEL_EXPORTER_OTLP_HEADERS || env.HYPERDX_API_KEY) {
     console.warn(
       `${LOG_PREFIX} Tracing is enabled with configs (${JSON.stringify(
         {
           advancedNetworkCapture: config.advancedNetworkCapture,
           betaMode: config.betaMode,
           consoleCapture: consoleInstrumentationEnabled,
-          endpoint: env.OTEL_EXPORTER_OTLP_ENDPOINT,
-          logLevel: env.OTEL_LOG_LEVEL,
+          endpoint: DEFAULT_OTEL_TRACES_EXPORTER_URL,
+          logLevel: DEFAULT_OTEL_LOG_LEVEL,
           propagators: env.OTEL_PROPAGATORS,
           resourceAttributes: env.OTEL_RESOURCE_ATTRIBUTES,
           resourceDetectors: env.OTEL_NODE_RESOURCE_DETECTORS,
-          sampler: env.OTEL_TRACES_SAMPLER,
-          samplerArg: env.OTEL_TRACES_SAMPLER_ARG,
-          serviceName: env.OTEL_SERVICE_NAME,
+          sampler: DEFAULT_OTEL_TRACES_SAMPLER,
+          samplerArg: DEFAULT_OTEL_TRACES_SAMPLER_ARG,
+          serviceName: DEFAULT_SERVICE_NAME,
           stopOnTerminationSignals,
         },
         null,
@@ -144,7 +164,7 @@ export const initSDK = (config: SDKConfig) => {
     }
   } else {
     console.warn(
-      `${LOG_PREFIX} OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS are not set, tracing is disabled`,
+      `${LOG_PREFIX} HYPERDX_API_KEY or OTEL_EXPORTER_OTLP_HEADERS is not set, tracing is disabled`,
     );
   }
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@hyperdx/node-opentelemetry': patch
 +---
++
 +fix: disable console instrumentation if otel debug mode is on