feat: add OTEL_LOG_LEVEL env var

User can now control the log level by means of env var. Signed-off-by: Naseem <naseem@transit.app>
open-telemetry · Apr 18, 2020 · c1dc696 · c1dc696
1 parent b7dcb8c
commit c1dc696
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 6 deletions.
diff --git a/packages/opentelemetry-core/src/common/ConsoleLogger.ts b/packages/opentelemetry-core/src/common/ConsoleLogger.ts
@@ -15,10 +15,14 @@
  */
 
 import { Logger } from '@opentelemetry/api';
-import { LogLevel } from './types';
+import { LogLevel, LogLevelStrings } from './types';
 
 export class ConsoleLogger implements Logger {
-  constructor(level: LogLevel = LogLevel.INFO) {
+  constructor(
+    level: LogLevel = process.env.OTEL_LOG_LEVEL
+      ? LogLevel[process.env.OTEL_LOG_LEVEL as LogLevelStrings]
+      : LogLevel.INFO
+  ) {
     if (level >= LogLevel.DEBUG) {
       this.debug = (...args) => {
         console.debug(...args);

diff --git a/packages/opentelemetry-core/src/common/types.ts b/packages/opentelemetry-core/src/common/types.ts
@@ -22,6 +22,8 @@ export enum LogLevel {
   DEBUG,
 }
 
+export type LogLevelStrings = keyof typeof LogLevel;
+
 /**
  * This interface defines a fallback to read a timeOrigin when it is not available on performance.timeOrigin,
  * this happens for example on Safari Mac

diff --git a/packages/opentelemetry-core/test/common/ConsoleLogger.test.ts b/packages/opentelemetry-core/test/common/ConsoleLogger.test.ts
@@ -54,6 +54,7 @@ describe('ConsoleLogger', () => {
     console.info = origInfo;
     console.warn = origWarn;
     console.error = origError;
+    delete process.env.OTEL_LOG_LEVEL;
   });
 
   describe('constructor', () => {
@@ -67,6 +68,19 @@ describe('ConsoleLogger', () => {
       assert.deepStrictEqual(infoCalledArgs, ['info called %s', 'param1']);
     });
 
+    it('should log with environmentally set level', () => {
+      process.env.OTEL_LOG_LEVEL = 'DEBUG';
+      const consoleLogger = new ConsoleLogger();
+      consoleLogger.error('error called');
+      assert.deepStrictEqual(errorCalledArgs, ['error called']);
+      consoleLogger.warn('warn called %s', 'param1');
+      assert.deepStrictEqual(warnCalledArgs, ['warn called %s', 'param1']);
+      consoleLogger.info('info called %s', 'param1');
+      assert.deepStrictEqual(infoCalledArgs, ['info called %s', 'param1']);
+      consoleLogger.debug('debug called %s', 'param1');
+      assert.deepStrictEqual(debugCalledArgs, ['debug called %s', 'param1']);
+    });
+
     it('should log with debug', () => {
       const consoleLogger = new ConsoleLogger(LogLevel.DEBUG);
       consoleLogger.error('error called');

diff --git a/packages/opentelemetry-metrics/src/types.ts b/packages/opentelemetry-metrics/src/types.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { LogLevel } from '@opentelemetry/core';
+import { LogLevel, LogLevelStrings } from '@opentelemetry/core';
 import { Logger, ValueType } from '@opentelemetry/api';
 import { MetricExporter } from './export/types';
 import { Resource } from '@opentelemetry/resources';
@@ -76,7 +76,9 @@ export interface MeterConfig {
 
 /** Default Meter configuration. */
 export const DEFAULT_CONFIG = {
-  logLevel: LogLevel.INFO,
+  logLevel: process.env.OTEL_LOG_LEVEL
+    ? LogLevel[process.env.OTEL_LOG_LEVEL as LogLevelStrings]
+    : LogLevel.INFO,
 };
 
 /** The default metric creation options value. */

diff --git a/packages/opentelemetry-tracing/src/config.ts b/packages/opentelemetry-tracing/src/config.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { ALWAYS_SAMPLER, LogLevel } from '@opentelemetry/core';
+import { ALWAYS_SAMPLER, LogLevel, LogLevelStrings } from '@opentelemetry/core';
 
 /** Default limit for Message events per span */
 export const DEFAULT_MAX_EVENTS_PER_SPAN = 128;
@@ -31,7 +31,9 @@ export const DEFAULT_MAX_LINKS_PER_SPAN = 32;
  */
 export const DEFAULT_CONFIG = {
   defaultAttributes: {},
-  logLevel: LogLevel.INFO,
+  logLevel: process.env.OTEL_LOG_LEVEL
+    ? LogLevel[process.env.OTEL_LOG_LEVEL as LogLevelStrings]
+    : LogLevel.INFO,
   sampler: ALWAYS_SAMPLER,
   traceParams: {
     numberOfAttributesPerSpan: DEFAULT_MAX_ATTRIBUTES_PER_SPAN,