disable automatic log sending for bunyan

signalfx · Dec 12, 2023 · 5cc2d2a · 5cc2d2a
1 parent 5265f83
commit 5cc2d2a
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 30 deletions.
diff --git a/src/instrumentations/logging.ts b/src/instrumentations/logging.ts
@@ -16,6 +16,8 @@
 
 import { Span } from '@opentelemetry/sdk-trace-base';
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
+import type { BunyanInstrumentation } from '@opentelemetry/instrumentation-bunyan';
+import { getEnvBoolean } from '../utils';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type LogRecord = Record<string, any>;
@@ -59,3 +61,12 @@ export function configureLogInjection(
     return instrumentation.setConfig(config);
   }
 }
+
+export function disableLogSending(instrumentation: BunyanInstrumentation) {
+  const enabled = getEnvBoolean('SPLUNK_AUTOMATIC_LOG_COLLECTION', false);
+  instrumentation.setConfig(
+    Object.assign({}, instrumentation.getConfig(), {
+      disableLogSending: !enabled,
+    })
+  );
+}
diff --git a/src/tracing/index.ts b/src/tracing/index.ts
@@ -37,7 +37,10 @@ import {
 } from '@opentelemetry/context-async-hooks';
 
 import { configureHttpInstrumentation } from '../instrumentations/http';
-import { configureLogInjection } from '../instrumentations/logging';
+import {
+  configureLogInjection,
+  disableLogSending,
+} from '../instrumentations/logging';
 import { allowedTracingOptions, Options, _setDefaultOptions } from './options';
 import { configureRedisInstrumentation } from '../instrumentations/redis';
 import {
@@ -221,6 +224,9 @@ function configureInstrumentations(options: Options) {
         configureRedisInstrumentation(instr, options);
         break;
       case '@opentelemetry/instrumentation-bunyan':
+        disableLogSending(instr);
+        configureLogInjection(instr);
+        break;
       case '@opentelemetry/instrumentation-pino':
       case '@opentelemetry/instrumentation-winston':
         configureLogInjection(instr);

diff --git a/src/types.ts b/src/types.ts
@@ -37,6 +37,7 @@ export type EnvVarKey =
   | 'OTEL_TRACES_EXPORTER'
   | 'SPLUNK_ACCESS_TOKEN'
   | 'SPLUNK_AUTOINSTRUMENT_PACKAGE_NAMES'
+  | 'SPLUNK_AUTOMATIC_LOG_COLLECTION'
   | 'SPLUNK_DEBUG_METRICS_ENABLED'
   | 'SPLUNK_INSTRUMENTATION_METRICS_ENABLED'
   | 'SPLUNK_METRICS_ENABLED'

diff --git a/test/loginjection.test.ts b/test/loginjection.test.ts
@@ -22,7 +22,6 @@ import { startTracing, stopTracing } from '../src/tracing';
 import { defaultLogHook } from '../src/instrumentations/logging';
 import type * as pino from 'pino';
 import type * as bunyan from 'bunyan';
-import type * as winston from 'winston';
 import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
 
 describe('log injection', () => {
@@ -60,35 +59,14 @@ describe('log injection', () => {
     record = {};
   });
 
-  describe('default flow', () => {
-    before(() => {
-      startTracing({ serviceName: 'test-service' });
-    });
-
-    after(() => {
-      stopTracing();
-    });
-
-    it('injects context to bunyan records', () => {
-      const logger: bunyan = require('bunyan').createLogger({
-        name: 'test',
-        stream,
-      });
-      assertInjection(logger);
-    });
-
-    it('injects context to pino records', () => {
-      const logger: pino.Logger = require('pino')(stream);
-      assertInjection(logger);
-    });
-
-    it('injects context to winston records', () => {
-      const winston: winston = require('winston');
-      const logger = winston.createLogger({
-        transports: [new winston.transports.Stream({ stream })],
-      });
-      assertInjection(logger);
+  it('injects context to winston records', () => {
+    startTracing({ serviceName: 'test-service' });
+    const winston: winston = require('winston');
+    const logger = winston.createLogger({
+      transports: [new winston.transports.Stream({ stream })],
     });
+    assertInjection(logger);
+    stopTracing();
   });
 
   describe('injecting with custom hook', () => {