refactor(auto-instrumentations-node): use env var utility functions to setup diagnostics logging (#2778)

Author: danherd

metapackages/auto-instrumentations-node/package.json

@@ -33,10 +33,12 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js-contrib/issues"
   },
   "peerDependencies": {
-    "@opentelemetry/api": "^1.4.1"
+    "@opentelemetry/api": "^1.4.1",
+    "@opentelemetry/core": "^2.0.0"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.4.1",
+    "@opentelemetry/core": "^2.0.0",
     "@types/mocha": "10.0.10",
     "@types/node": "18.18.14",
     "@types/sinon": "17.0.4",

metapackages/auto-instrumentations-node/src/register.ts

@@ -15,13 +15,18 @@
  */
 import * as opentelemetry from '@opentelemetry/sdk-node';
 import { diag, DiagConsoleLogger } from '@opentelemetry/api';
+import { getStringFromEnv, diagLogLevelFromString } from '@opentelemetry/core';
 import {
-  getLogLevelFromEnv,
   getNodeAutoInstrumentations,
   getResourceDetectorsFromEnv,
 } from './utils';
 
-diag.setLogger(new DiagConsoleLogger(), getLogLevelFromEnv());
+const logLevel = getStringFromEnv('OTEL_LOG_LEVEL');
+if (logLevel != null) {
+  diag.setLogger(new DiagConsoleLogger(), {
+    logLevel: diagLogLevelFromString(logLevel),
+  });
+}
 
 const sdk = new opentelemetry.NodeSDK({
   instrumentations: getNodeAutoInstrumentations(),

metapackages/auto-instrumentations-node/src/utils.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { diag, DiagLogLevel } from '@opentelemetry/api';
+import { diag } from '@opentelemetry/api';
 import { Instrumentation } from '@opentelemetry/instrumentation';
 
 import { AmqplibInstrumentation } from '@opentelemetry/instrumentation-amqplib';
@@ -135,17 +135,6 @@ const InstrumentationMap = {
   '@opentelemetry/instrumentation-winston': WinstonInstrumentation,
 };
 
-// The support string -> DiagLogLevel mappings
-const logLevelMap: { [key: string]: DiagLogLevel } = {
-  ALL: DiagLogLevel.ALL,
-  VERBOSE: DiagLogLevel.VERBOSE,
-  DEBUG: DiagLogLevel.DEBUG,
-  INFO: DiagLogLevel.INFO,
-  WARN: DiagLogLevel.WARN,
-  ERROR: DiagLogLevel.ERROR,
-  NONE: DiagLogLevel.NONE,
-};
-
 const defaultExcludedInstrumentations = [
   '@opentelemetry/instrumentation-fs',
   '@opentelemetry/instrumentation-fastify',
@@ -303,16 +292,3 @@ export function getResourceDetectorsFromEnv(): Array<ResourceDetector> {
     return resourceDetector || [];
   });
 }
-
-export function getLogLevelFromEnv(): DiagLogLevel {
-  const rawLogLevel = process.env.OTEL_LOG_LEVEL;
-
-  // NOTE: as per specification we should actually only register if something is set, but our previous implementation
-  // always registered a logger, even when nothing was set. Falling back to 'INFO' here to keep the same behavior as
-  // with previous implementations.
-  // Also: no point in warning - no logger is registered yet
-  return (
-    logLevelMap[rawLogLevel?.trim().toUpperCase() ?? 'INFO'] ??
-    DiagLogLevel.INFO
-  );
-}

metapackages/auto-instrumentations-node/test/utils.test.ts

@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-import { diag, DiagLogLevel } from '@opentelemetry/api';
+import { diag } from '@opentelemetry/api';
 import { HttpInstrumentationConfig } from '@opentelemetry/instrumentation-http';
 import * as assert from 'assert';
 import * as sinon from 'sinon';
 import { getNodeAutoInstrumentations } from '../src';
-import { getLogLevelFromEnv, getResourceDetectorsFromEnv } from '../src/utils';
+import { getResourceDetectorsFromEnv } from '../src/utils';
 
 describe('utils', () => {
   describe('getNodeAutoInstrumentations', () => {
@@ -223,44 +223,4 @@ describe('utils', () => {
       delete process.env.OTEL_NODE_RESOURCE_DETECTORS;
     });
   });
-
-  describe('getLogLevelFromEnv', function () {
-    afterEach(function () {
-      delete process.env.OTEL_LOG_LEVEL;
-    });
-
-    it('should select log level based on env var', function () {
-      process.env.OTEL_LOG_LEVEL = 'NONE';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.NONE);
-      process.env.OTEL_LOG_LEVEL = 'VERBOSE';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.VERBOSE);
-      process.env.OTEL_LOG_LEVEL = 'DEBUG';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.DEBUG);
-      process.env.OTEL_LOG_LEVEL = 'INFO';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.INFO);
-      process.env.OTEL_LOG_LEVEL = 'WARN';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.WARN);
-      process.env.OTEL_LOG_LEVEL = 'ERROR';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.ERROR);
-      process.env.OTEL_LOG_LEVEL = 'ALL';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.ALL);
-    });
-
-    it('should ignore casing', function () {
-      process.env.OTEL_LOG_LEVEL = 'warn';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.WARN);
-      process.env.OTEL_LOG_LEVEL = 'WaRN';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.WARN);
-    });
-
-    it('should fall back to INFO on bogus input', function () {
-      process.env.OTEL_LOG_LEVEL = 'bogus';
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.INFO);
-    });
-
-    it('should use INFO when unset', function () {
-      delete process.env.OTEL_LOG_LEVEL;
-      assert.strictEqual(getLogLevelFromEnv(), DiagLogLevel.INFO);
-    });
-  });
 });