disableInjection -> disableLogCorrelation

plugins/node/opentelemetry-instrumentation-bunyan/README.md

@@ -3,7 +3,7 @@
 [![NPM Published Version][npm-img]][npm-url]
 [![Apache License][license-image]][license-image]
 
-This module provides automatic instrumentation of the [`bunyan`](https://www.npmjs.com/package/bunyan) module to inject trace-context into Bunyan log records and to bridge Bunyan logging to the OpenTelemetry Logging SDK. It may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle.
+This module provides automatic instrumentation of the [`bunyan`](https://www.npmjs.com/package/bunyan) module to inject trace-context into Bunyan log records (Log correlation) and to bridge Bunyan logging to the OpenTelemetry Logging SDK. It may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle.
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
@@ -44,8 +44,9 @@ logger.info('hi');
 const tracer = api.trace.getTracer('example');
 tracer.startActiveSpan('manual-span', span => {
   logger.info('in a span');
-  // 2. Fields identifying the current span will be injected into log records:
+  // 2. Fields identifying the current span will be added to log records:
   //    {"name":"example",...,"msg":"in a span","trace_id":"d61b4e4af1032e0aae279d12f3ab0159","span_id":"d140da862204f2a2","trace_flags":"01"}
+  //    This is called "log correlation".
 })
 ```
 
@@ -57,10 +58,13 @@ If the OpenTelemetry SDK is not configured with a Logger provider, then this add
 
 The logs bridge can be disabled with the `disableLogsBridge: true` option.
 
-### Log injection
+### Log correlation
 
-Bunyan logger calls in the context of a tracing span will have fields indentifying
-the span ([spec](https://opentelemetry.io/docs/specs/otel/compatibility/logging_trace_context/)):
+Bunyan logger calls in the context of a tracing span will have fields
+indentifying the span added to the log record. This allows
+[correlating](https://opentelemetry.io/docs/specs/otel/logs/#log-correlation)
+log records with tracing data. The added fields are
+([spec](https://opentelemetry.io/docs/specs/otel/compatibility/logging_trace_context/)):
 
 - `trace_id`
 - `span_id`
@@ -75,15 +79,15 @@ After adding these fields, the optional `logHook` is called to allow injecting a
 ```
 
 When no span context is active or the span context is invalid, injection is skipped.
-Log injection can be disabled with the `disableInjection: true` option.
+Log injection can be disabled with the `disableLogCorrelation: true` option.
 
 ### Bunyan instrumentation options
 
-| Option              | Type              | Description |
-| ------------------- | ----------------- | ----------- |
-| `disableLogsBridge` | `boolean`         | Whether to disable [logs bridging](#logs-bridge). Default `false`. |
-| `disableInjection`  | `boolean`         | Whether to disable [log injection](#log-injection). Default `false`. |
-| `logHook`           | `LogHookFunction` | An option hook to inject additional context to a log record after span context has been added. This requires `disableInjection` to be false. |
+| Option                  | Type              | Description |
+| ----------------------- | ----------------- | ----------- |
+| `disableLogsBridge`     | `boolean`         | Whether to disable [logs bridging](#logs-bridge). Default `false`. |
+| `disableLogCorrelation` | `boolean`         | Whether to disable [log correlation](#log-correlation). Default `false`. |
+| `logHook`               | `LogHookFunction` | An option hook to inject additional context to a log record after trace-context has been added. This requires `disableLogCorrelation` to be false. |
 
 ### Using OpenTelemetryBunyanStream without instrumentation
 

plugins/node/opentelemetry-instrumentation-bunyan/examples/README.md

@@ -63,8 +63,8 @@ $ node -r ./telemetry.js app.js
 }
 ```
 
-There are two separate Bunyan instrumentation functionalities. The first, called
-"log injection", is that Bunyan log records emitted in the context of a tracing
+There are two separate Bunyan instrumentation features. The first, called
+"log correlation", is that Bunyan log records emitted in the context of a tracing
 span will include `trace_id` and `span_id` fields that can be used for
 correlating with collected tracing data.
 

plugins/node/opentelemetry-instrumentation-bunyan/src/instrumentation.ts

@@ -28,7 +28,7 @@ import type * as BunyanLogger from 'bunyan';
 
 const DEFAULT_CONFIG: BunyanInstrumentationConfig = {
   disableLogsBridge: false,
-  disableInjection: false,
+  disableLogCorrelation: false,
 };
 
 export class BunyanInstrumentation extends InstrumentationBase<
@@ -114,7 +114,7 @@ export class BunyanInstrumentation extends InstrumentationBase<
       const instrumentation = this;
       return function patchedEmit(this: BunyanLogger, ...args: unknown[]) {
         const config = instrumentation.getConfig();
-        if (!instrumentation.isEnabled() || config.disableInjection) {
+        if (!instrumentation.isEnabled() || config.disableLogCorrelation) {
           return original.apply(this, args);
         }
 

plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts

@@ -29,16 +29,16 @@ export interface BunyanInstrumentationConfig extends InstrumentationConfig {
   disableLogsBridge?: boolean;
 
   /**
-   * Whether to disable the injection of data such as trace-context fields into
-   * log output.
+   * Whether to disable the injection trace-context fields, and possibly other
+   * fields from `logHook()`, into log records for log correlation.
    * @default false
    */
-  disableInjection?: boolean;
+  disableLogCorrelation?: boolean;
 
   /**
    * A function that allows injecting additional fields in log records. It is
    * called, as `logHook(span, record)`, for each log record emitted in a valid
-   * span context. It requires `disableInjection` to be false.
+   * span context. It requires `disableLogCorrelation` to be false.
    */
   logHook?: LogHookFunction;
 }

plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts

@@ -156,9 +156,9 @@ describe('BunyanInstrumentation', () => {
       });
     });
 
-    it('does not inject or call logHook if disableInjection=true', () => {
+    it('does not inject or call logHook if disableLogCorrelation=true', () => {
       instrumentation.setConfig({
-        disableInjection: true,
+        disableLogCorrelation: true,
         logHook: (_span, record) => {
           record['resource.service.name'] = 'test-service';
         },
@@ -278,7 +278,7 @@ describe('BunyanInstrumentation', () => {
         log.info('foo');
         assert.strictEqual(memExporter.getFinishedLogRecords().length, 0);
 
-        // Test log injection still works.
+        // Test log correlation still works.
         sinon.assert.calledOnce(writeSpy);
         const record = JSON.parse(writeSpy.firstCall.args[0].toString());
         assert.strictEqual('foo', record['msg']);