@opentelemetry/instrumentation-winston 0.35.0 → 0.36.0

package/README.md

@@ -3,7 +3,7 @@
 [![NPM Published Version][npm-img]][npm-url]
 [![Apache License][license-image]][license-image]
 
-This module provides automatic instrumentation for injection of trace context for the [`winston`](https://www.npmjs.com/package/winston) module, which 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 [`winston`](https://www.npmjs.com/package/winston) module to inject trace-context into Winston log records (log correlation) and to send Winston logging to the OpenTelemetry Logging SDK (log sending). 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.
 
@@ -19,47 +19,92 @@ npm install --save @opentelemetry/instrumentation-winston
 
 ```js
 const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
+const logsAPI = require('@opentelemetry/api-logs');
+const {
+    LoggerProvider,
+    SimpleLogRecordProcessor,
+    ConsoleLogRecordExporter,
+} = require('@opentelemetry/sdk-logs');
 const { WinstonInstrumentation } = require('@opentelemetry/instrumentation-winston');
 const { registerInstrumentations } = require('@opentelemetry/instrumentation');
 
-const provider = new NodeTracerProvider();
-provider.register();
+const tracerProvider = new NodeTracerProvider();
+tracerProvider.register();
+
+// To start a logger, you first need to initialize the Logger provider.
+const loggerProvider = new LoggerProvider();
+// Add a processor to export log record
+loggerProvider.addLogRecordProcessor(
+    new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())
+);
+logsAPI.logs.setGlobalLoggerProvider(loggerProvider);
 
 registerInstrumentations({
-  instrumentations: [
-    new WinstonInstrumentation({
-      // Optional hook to insert additional context to log metadata.
-      // Called after trace context is injected to metadata.
-      logHook: (span, record) => {
-        record['resource.service.name'] = provider.resource.attributes['service.name'];
-      },
-    }),
-    // other instrumentations
-  ],
+    instrumentations: [
+        new WinstonInstrumentation({
+            // See below for Winston instrumentation options.
+        }),
+    ],
 });
 
 const winston = require('winston');
 const logger = winston.createLogger({
-  transports: [new winston.transports.Console()],
+    transports: [new winston.transports.Console()],
 })
 logger.info('foobar');
 // {"message":"foobar","trace_id":"e21c7a95fff34e04f77c7bd518779621","span_id":"b7589a981fde09f4","trace_flags":"01", ...}
 ```
 
-### Fields added to Winston metadata
+### Winston instrumentation options
+
+| Option                  | Type              | Description |
+| ----------------------- | ----------------- | ----------- |
+| `disableLogSending`      | `boolean`         | Whether to disable [log sending](#log-sending). 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. |  
+
+### Log sending
+
+Winston Logger will automatically send log records to the OpenTelemetry Logs SDK if not explicitly disabled in config and @opentelemetry/winston-transport npm package is installed in the project. The OpenTelemetry SDK can be configured to handle those records, for example, sending them on to an OpenTelemetry collector for log archiving and processing. The example above shows a minimal configuration that emits OpenTelemetry log records to the console for debugging.
+
+If the OpenTelemetry SDK is not configured with a Logger provider, then this will be a no-op.
+
+Log sending can be disabled with the `disableLogSending: true` option. Log sending is only available for Winston version 3 and later.
+
+```bash
+npm install --save @opentelemetry/winston-transport
+```
+
+### Log correlation
 
-For the current active span, the following fields are injected:
+Winston 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`
 * `trace_flags`
 
-When no span context is active or the span context is invalid, injection is skipped.
+After adding these fields, the optional `logHook` is called to allow injecting additional fields. For example:
+
+```js
+logHook: (span, record) => {
+  record['resource.service.name'] = provider.resource.attributes['service.name'];
+}
+```
+
+Log injection can be disabled with the `disableLogCorrelation: true` option.
 
 ### Supported versions
 
 `1.x`, `2.x`, `3.x`
 
+Log sending
+
+`3.x`
+
 ## Useful links
 
 * For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

package/build/src/instrumentation.d.ts

@@ -8,5 +8,7 @@ export declare class WinstonInstrumentation extends InstrumentationBase {
     private _callHook;
     private _getPatchedWrite;
     private _getPatchedLog;
+    private _getPatchedConfigure;
+    private _handleLogCorrelation;
 }
 //# sourceMappingURL=instrumentation.d.ts.map

package/build/src/instrumentation.js

@@ -26,38 +26,46 @@ class WinstonInstrumentation extends instrumentation_1.InstrumentationBase {
         super('@opentelemetry/instrumentation-winston', version_1.VERSION, config);
     }
     init() {
-        return [
-            new instrumentation_1.InstrumentationNodeModuleDefinition('winston', winston3Versions, moduleExports => moduleExports, () => { }, [
-                new instrumentation_1.InstrumentationNodeModuleFile('winston/lib/winston/logger.js', winston3Versions, (logger, moduleVersion) => {
-                    this._diag.debug(`Applying patch for winston@${moduleVersion}`);
-                    if ((0, instrumentation_1.isWrapped)(logger.prototype['write'])) {
-                        this._unwrap(logger.prototype, 'write');
-                    }
-                    this._wrap(logger.prototype, 'write', this._getPatchedWrite());
-                    return logger;
-                }, (logger, moduleVersion) => {
-                    if (logger === undefined)
-                        return;
-                    this._diag.debug(`Removing patch for winston@${moduleVersion}`);
+        const winstons3instrumentationNodeModuleDefinition = new instrumentation_1.InstrumentationNodeModuleDefinition('winston', winston3Versions, moduleExports => moduleExports, () => { }, [
+            new instrumentation_1.InstrumentationNodeModuleFile('winston/lib/winston/logger.js', winston3Versions, (logger, moduleVersion) => {
+                this._diag.debug(`Applying patch for winston@${moduleVersion}`);
+                if ((0, instrumentation_1.isWrapped)(logger.prototype['write'])) {
                     this._unwrap(logger.prototype, 'write');
-                }),
-            ]),
-            new instrumentation_1.InstrumentationNodeModuleDefinition('winston', winstonPre3Versions, moduleExports => moduleExports, () => { }, [
-                new instrumentation_1.InstrumentationNodeModuleFile('winston/lib/winston/logger.js', winstonPre3Versions, (fileExports, moduleVersion) => {
-                    this._diag.debug(`Applying patch for winston@${moduleVersion}`);
-                    const proto = fileExports.Logger.prototype;
-                    if ((0, instrumentation_1.isWrapped)(proto.log)) {
-                        this._unwrap(proto, 'log');
-                    }
-                    this._wrap(proto, 'log', this._getPatchedLog());
-                    return fileExports;
-                }, (fileExports, moduleVersion) => {
-                    if (fileExports === undefined)
-                        return;
-                    this._diag.debug(`Removing patch for winston@${moduleVersion}`);
-                    this._unwrap(fileExports.Logger.prototype, 'log');
-                }),
-            ]),
+                }
+                this._wrap(logger.prototype, 'write', this._getPatchedWrite());
+                // Wrap configure
+                if ((0, instrumentation_1.isWrapped)(logger.prototype['configure'])) {
+                    this._unwrap(logger.prototype, 'configure');
+                }
+                this._wrap(logger.prototype, 'configure', this._getPatchedConfigure());
+                return logger;
+            }, (logger, moduleVersion) => {
+                if (logger === undefined)
+                    return;
+                this._diag.debug(`Removing patch for winston@${moduleVersion}`);
+                this._unwrap(logger.prototype, 'write');
+                this._unwrap(logger.prototype, 'configure');
+            }),
+        ]);
+        const winstons2instrumentationNodeModuleDefinition = new instrumentation_1.InstrumentationNodeModuleDefinition('winston', winstonPre3Versions, moduleExports => moduleExports, () => { }, [
+            new instrumentation_1.InstrumentationNodeModuleFile('winston/lib/winston/logger.js', winstonPre3Versions, (fileExports, moduleVersion) => {
+                this._diag.debug(`Applying patch for winston@${moduleVersion}`);
+                const proto = fileExports.Logger.prototype;
+                if ((0, instrumentation_1.isWrapped)(proto.log)) {
+                    this._unwrap(proto, 'log');
+                }
+                this._wrap(proto, 'log', this._getPatchedLog());
+                return fileExports;
+            }, (fileExports, moduleVersion) => {
+                if (fileExports === undefined)
+                    return;
+                this._diag.debug(`Removing patch for winston@${moduleVersion}`);
+                this._unwrap(fileExports.Logger.prototype, 'log');
+            }),
+        ]);
+        return [
+            winstons3instrumentationNodeModuleDefinition,
+            winstons2instrumentationNodeModuleDefinition,
         ];
     }
     getConfig() {
@@ -81,17 +89,8 @@ class WinstonInstrumentation extends instrumentation_1.InstrumentationBase {
         return (original) => {
             const instrumentation = this;
             return function patchedWrite(...args) {
-                const span = api_1.trace.getSpan(api_1.context.active());
-                if (!span) {
-                    return original.apply(this, args);
-                }
-                const spanContext = span.spanContext();
-                if (!(0, api_1.isSpanContextValid)(spanContext)) {
-                    return original.apply(this, args);
-                }
                 const record = args[0];
-                injectRecord(spanContext, record);
-                instrumentation._callHook(span, record);
+                instrumentation._handleLogCorrelation(record);
                 return original.apply(this, args);
             };
         };
@@ -100,43 +99,76 @@ class WinstonInstrumentation extends instrumentation_1.InstrumentationBase {
         return (original) => {
             const instrumentation = this;
             return function patchedLog(...args) {
-                const span = api_1.trace.getSpan(api_1.context.active());
-                if (!span) {
-                    return original.apply(this, args);
-                }
-                const spanContext = span.spanContext();
-                if (!(0, api_1.isSpanContextValid)(spanContext)) {
-                    return original.apply(this, args);
-                }
+                const record = {};
+                instrumentation._handleLogCorrelation(record);
+                // Inject in metadata argument
+                let isDataInjected = false;
                 for (let i = args.length - 1; i >= 0; i--) {
                     if (typeof args[i] === 'object') {
-                        const record = args[i];
-                        injectRecord(spanContext, record);
-                        instrumentation._callHook(span, record);
-                        return original.apply(this, args);
+                        args[i] = Object.assign(args[i], record);
+                        isDataInjected = true;
+                        break;
                     }
                 }
-                const record = injectRecord(spanContext);
-                const insertAt = typeof args[args.length - 1] === 'function'
-                    ? args.length - 1
-                    : args.length;
-                args.splice(insertAt, 0, record);
-                instrumentation._callHook(span, record);
+                if (!isDataInjected) {
+                    const insertAt = typeof args[args.length - 1] === 'function'
+                        ? args.length - 1
+                        : args.length;
+                    args.splice(insertAt, 0, record);
+                }
                 return original.apply(this, args);
             };
         };
     }
-}
-exports.WinstonInstrumentation = WinstonInstrumentation;
-function injectRecord(spanContext, record) {
-    const fields = {
-        trace_id: spanContext.traceId,
-        span_id: spanContext.spanId,
-        trace_flags: `0${spanContext.traceFlags.toString(16)}`,
-    };
-    if (!record) {
-        return fields;
+    _getPatchedConfigure() {
+        return (original) => {
+            const instrumentation = this;
+            return function patchedConfigure(...args) {
+                const config = instrumentation.getConfig();
+                if (!config.disableLogSending) {
+                    if (args && args.length > 0) {
+                        // Try to load Winston transport
+                        try {
+                            const { OpenTelemetryTransportV3, } = require('@opentelemetry/winston-transport');
+                            const originalTransports = args[0].transports;
+                            let newTransports = Array.isArray(originalTransports)
+                                ? originalTransports
+                                : [];
+                            const openTelemetryTransport = new OpenTelemetryTransportV3();
+                            if (originalTransports && !Array.isArray(originalTransports)) {
+                                newTransports = [originalTransports];
+                            }
+                            newTransports.push(openTelemetryTransport);
+                            args[0].transports = newTransports;
+                        }
+                        catch (err) {
+                            instrumentation._diag.warn('OpenTelemetry Winston transport is not available, log records will not be automatically sent.', err);
+                        }
+                    }
+                }
+                return original.apply(this, args);
+            };
+        };
+    }
+    _handleLogCorrelation(record) {
+        if (!this.getConfig().disableLogCorrelation) {
+            const span = api_1.trace.getSpan(api_1.context.active());
+            if (span) {
+                const spanContext = span.spanContext();
+                if ((0, api_1.isSpanContextValid)(spanContext)) {
+                    const fields = {
+                        trace_id: spanContext.traceId,
+                        span_id: spanContext.spanId,
+                        trace_flags: `0${spanContext.traceFlags.toString(16)}`,
+                    };
+                    const enhancedRecord = Object.assign(record, fields);
+                    this._callHook(span, enhancedRecord);
+                    return enhancedRecord;
+                }
+            }
+        }
+        return record;
     }
-    return Object.assign(record, fields);
 }
+exports.WinstonInstrumentation = WinstonInstrumentation;
 //# sourceMappingURL=instrumentation.js.map

package/build/src/instrumentation.js.map

@@ -1 +1 @@
-{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../src/instrumentation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4CAM4B;AAC5B,oEAMwC;AAQxC,uCAAoC;AAEpC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,CAAC,CAAC;AACpC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,CAAC,CAAC;AAEvC,MAAa,sBAAuB,SAAQ,qCAAmB;IAC7D,YAAY,SAAuC,EAAE;QACnD,KAAK,CAAC,wCAAwC,EAAE,iBAAO,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAES,IAAI;QACZ,OAAO;YACL,IAAI,qDAAmC,CACrC,SAAS,EACT,gBAAgB,EAChB,aAAa,CAAC,EAAE,CAAC,aAAa,EAC9B,GAAG,EAAE,GAAE,CAAC,EACR;gBACE,IAAI,+CAA6B,CAC/B,+BAA+B,EAC/B,gBAAgB,EAChB,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE;oBACxB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;oBAChE,IAAI,IAAA,2BAAS,EAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE;wBACxC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;qBACzC;oBAED,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;oBAC/D,OAAO,MAAM,CAAC;gBAChB,CAAC,EACD,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE;oBACxB,IAAI,MAAM,KAAK,SAAS;wBAAE,OAAO;oBACjC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;oBAChE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBAC1C,CAAC,CACF;aACF,CACF;YACD,IAAI,qDAAmC,CACrC,SAAS,EACT,mBAAmB,EACnB,aAAa,CAAC,EAAE,CAAC,aAAa,EAC9B,GAAG,EAAE,GAAE,CAAC,EACR;gBACE,IAAI,+CAA6B,CAC/B,+BAA+B,EAC/B,mBAAmB,EACnB,CAAC,WAAW,EAAE,aAAa,EAAE,EAAE;oBAC7B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;oBAChE,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC;oBAE3C,IAAI,IAAA,2BAAS,EAAC,KAAK,CAAC,GAAG,CAAC,EAAE;wBACxB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;qBAC5B;oBAED,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;oBAEhD,OAAO,WAAW,CAAC;gBACrB,CAAC,EACD,CAAC,WAAW,EAAE,aAAa,EAAE,EAAE;oBAC7B,IAAI,WAAW,KAAK,SAAS;wBAAE,OAAO;oBACtC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;oBAChE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBACpD,CAAC,CACF;aACF,CACF;SACF,CAAC;IACJ,CAAC;IAEQ,SAAS;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEQ,SAAS,CAAC,MAAoC;QACrD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAEO,SAAS,CAAC,IAAU,EAAE,MAA8B;QAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC;QAEtC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QAED,IAAA,wCAAsB,EACpB,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EACxB,GAAG,CAAC,EAAE;YACJ,IAAI,GAAG,EAAE;gBACP,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;aAChD;QACH,CAAC,EACD,IAAI,CACL,CAAC;IACJ,CAAC;IAEO,gBAAgB;QACtB,OAAO,CAAC,QAA2B,EAAE,EAAE;YACrC,MAAM,eAAe,GAAG,IAAI,CAAC;YAC7B,OAAO,SAAS,YAAY,CAE1B,GAAG,IAAiC;gBAEpC,MAAM,IAAI,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,CAAC;gBAE7C,IAAI,CAAC,IAAI,EAAE;oBACT,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBACnC;gBAED,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;gBAEvC,IAAI,CAAC,IAAA,wBAAkB,EAAC,WAAW,CAAC,EAAE;oBACpC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBACnC;gBAED,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACvB,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBAClC,eAAe,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAExC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAEO,cAAc;QACpB,OAAO,CAAC,QAA2B,EAAE,EAAE;YACrC,MAAM,eAAe,GAAG,IAAI,CAAC;YAC7B,OAAO,SAAS,UAAU,CAExB,GAAG,IAAiC;gBAEpC,MAAM,IAAI,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,CAAC;gBAE7C,IAAI,CAAC,IAAI,EAAE;oBACT,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBACnC;gBAED,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;gBAEvC,IAAI,CAAC,IAAA,wBAAkB,EAAC,WAAW,CAAC,EAAE;oBACpC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBACnC;gBAED,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;oBACzC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;wBAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;wBACvB,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;wBAClC,eAAe,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;wBACxC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;qBACnC;iBACF;gBAED,MAAM,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;gBAEzC,MAAM,QAAQ,GACZ,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,UAAU;oBACzC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;oBACjB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;gBAElB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;gBACjC,eAAe,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAExC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;CACF;AAjKD,wDAiKC;AAED,SAAS,YAAY,CACnB,WAAwB,EACxB,MAA+B;IAE/B,MAAM,MAAM,GAAG;QACb,QAAQ,EAAE,WAAW,CAAC,OAAO;QAC7B,OAAO,EAAE,WAAW,CAAC,MAAM;QAC3B,WAAW,EAAE,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;KACvD,CAAC;IAEF,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,MAAM,CAAC;KACf;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  context,\n  trace,\n  isSpanContextValid,\n  Span,\n  SpanContext,\n} from '@opentelemetry/api';\nimport {\n  InstrumentationBase,\n  InstrumentationNodeModuleDefinition,\n  InstrumentationNodeModuleFile,\n  isWrapped,\n  safeExecuteInTheMiddle,\n} from '@opentelemetry/instrumentation';\nimport type { WinstonInstrumentationConfig } from './types';\nimport type {\n  Winston2LogMethod,\n  Winston2LoggerModule,\n  Winston3LogMethod,\n  Winston3Logger,\n} from './internal-types';\nimport { VERSION } from './version';\n\nconst winston3Versions = ['>=3 <4'];\nconst winstonPre3Versions = ['>=1 <3'];\n\nexport class WinstonInstrumentation extends InstrumentationBase {\n  constructor(config: WinstonInstrumentationConfig = {}) {\n    super('@opentelemetry/instrumentation-winston', VERSION, config);\n  }\n\n  protected init() {\n    return [\n      new InstrumentationNodeModuleDefinition<{}>(\n        'winston',\n        winston3Versions,\n        moduleExports => moduleExports,\n        () => {},\n        [\n          new InstrumentationNodeModuleFile<Winston3Logger>(\n            'winston/lib/winston/logger.js',\n            winston3Versions,\n            (logger, moduleVersion) => {\n              this._diag.debug(`Applying patch for winston@${moduleVersion}`);\n              if (isWrapped(logger.prototype['write'])) {\n                this._unwrap(logger.prototype, 'write');\n              }\n\n              this._wrap(logger.prototype, 'write', this._getPatchedWrite());\n              return logger;\n            },\n            (logger, moduleVersion) => {\n              if (logger === undefined) return;\n              this._diag.debug(`Removing patch for winston@${moduleVersion}`);\n              this._unwrap(logger.prototype, 'write');\n            }\n          ),\n        ]\n      ),\n      new InstrumentationNodeModuleDefinition<{}>(\n        'winston',\n        winstonPre3Versions,\n        moduleExports => moduleExports,\n        () => {},\n        [\n          new InstrumentationNodeModuleFile<Winston2LoggerModule>(\n            'winston/lib/winston/logger.js',\n            winstonPre3Versions,\n            (fileExports, moduleVersion) => {\n              this._diag.debug(`Applying patch for winston@${moduleVersion}`);\n              const proto = fileExports.Logger.prototype;\n\n              if (isWrapped(proto.log)) {\n                this._unwrap(proto, 'log');\n              }\n\n              this._wrap(proto, 'log', this._getPatchedLog());\n\n              return fileExports;\n            },\n            (fileExports, moduleVersion) => {\n              if (fileExports === undefined) return;\n              this._diag.debug(`Removing patch for winston@${moduleVersion}`);\n              this._unwrap(fileExports.Logger.prototype, 'log');\n            }\n          ),\n        ]\n      ),\n    ];\n  }\n\n  override getConfig(): WinstonInstrumentationConfig {\n    return this._config;\n  }\n\n  override setConfig(config: WinstonInstrumentationConfig) {\n    this._config = config;\n  }\n\n  private _callHook(span: Span, record: Record<string, string>) {\n    const hook = this.getConfig().logHook;\n\n    if (!hook) {\n      return;\n    }\n\n    safeExecuteInTheMiddle(\n      () => hook(span, record),\n      err => {\n        if (err) {\n          this._diag.error('error calling logHook', err);\n        }\n      },\n      true\n    );\n  }\n\n  private _getPatchedWrite() {\n    return (original: Winston3LogMethod) => {\n      const instrumentation = this;\n      return function patchedWrite(\n        this: never,\n        ...args: Parameters<typeof original>\n      ) {\n        const span = trace.getSpan(context.active());\n\n        if (!span) {\n          return original.apply(this, args);\n        }\n\n        const spanContext = span.spanContext();\n\n        if (!isSpanContextValid(spanContext)) {\n          return original.apply(this, args);\n        }\n\n        const record = args[0];\n        injectRecord(spanContext, record);\n        instrumentation._callHook(span, record);\n\n        return original.apply(this, args);\n      };\n    };\n  }\n\n  private _getPatchedLog() {\n    return (original: Winston2LogMethod) => {\n      const instrumentation = this;\n      return function patchedLog(\n        this: unknown,\n        ...args: Parameters<typeof original>\n      ) {\n        const span = trace.getSpan(context.active());\n\n        if (!span) {\n          return original.apply(this, args);\n        }\n\n        const spanContext = span.spanContext();\n\n        if (!isSpanContextValid(spanContext)) {\n          return original.apply(this, args);\n        }\n\n        for (let i = args.length - 1; i >= 0; i--) {\n          if (typeof args[i] === 'object') {\n            const record = args[i];\n            injectRecord(spanContext, record);\n            instrumentation._callHook(span, record);\n            return original.apply(this, args);\n          }\n        }\n\n        const record = injectRecord(spanContext);\n\n        const insertAt =\n          typeof args[args.length - 1] === 'function'\n            ? args.length - 1\n            : args.length;\n\n        args.splice(insertAt, 0, record);\n        instrumentation._callHook(span, record);\n\n        return original.apply(this, args);\n      };\n    };\n  }\n}\n\nfunction injectRecord(\n  spanContext: SpanContext,\n  record?: Record<string, string>\n) {\n  const fields = {\n    trace_id: spanContext.traceId,\n    span_id: spanContext.spanId,\n    trace_flags: `0${spanContext.traceFlags.toString(16)}`,\n  };\n\n  if (!record) {\n    return fields;\n  }\n\n  return Object.assign(record, fields);\n}\n"]}
+{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../src/instrumentation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4CAA8E;AAC9E,oEAMwC;AASxC,uCAAoC;AAEpC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,CAAC,CAAC;AACpC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,CAAC,CAAC;AAEvC,MAAa,sBAAuB,SAAQ,qCAAmB;IAC7D,YAAY,SAAuC,EAAE;QACnD,KAAK,CAAC,wCAAwC,EAAE,iBAAO,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAES,IAAI;QACZ,MAAM,4CAA4C,GAChD,IAAI,qDAAmC,CACrC,SAAS,EACT,gBAAgB,EAChB,aAAa,CAAC,EAAE,CAAC,aAAa,EAC9B,GAAG,EAAE,GAAE,CAAC,EACR;YACE,IAAI,+CAA6B,CAC/B,+BAA+B,EAC/B,gBAAgB,EAChB,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE;gBACxB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;gBAChE,IAAI,IAAA,2BAAS,EAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE;oBACxC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;iBACzC;gBACD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBAE/D,iBAAiB;gBACjB,IAAI,IAAA,2BAAS,EAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE;oBAC5C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;iBAC7C;gBACD,IAAI,CAAC,KAAK,CACR,MAAM,CAAC,SAAS,EAChB,WAAW,EACX,IAAI,CAAC,oBAAoB,EAAE,CAC5B,CAAC;gBAEF,OAAO,MAAM,CAAC;YAChB,CAAC,EACD,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE;gBACxB,IAAI,MAAM,KAAK,SAAS;oBAAE,OAAO;gBACjC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;gBAChE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBACxC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAC9C,CAAC,CACF;SACF,CACF,CAAC;QAEJ,MAAM,4CAA4C,GAChD,IAAI,qDAAmC,CACrC,SAAS,EACT,mBAAmB,EACnB,aAAa,CAAC,EAAE,CAAC,aAAa,EAC9B,GAAG,EAAE,GAAE,CAAC,EACR;YACE,IAAI,+CAA6B,CAC/B,+BAA+B,EAC/B,mBAAmB,EACnB,CAAC,WAAW,EAAE,aAAa,EAAE,EAAE;gBAC7B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;gBAChE,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC;gBAE3C,IAAI,IAAA,2BAAS,EAAC,KAAK,CAAC,GAAG,CAAC,EAAE;oBACxB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;iBAC5B;gBACD,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;gBAEhD,OAAO,WAAW,CAAC;YACrB,CAAC,EACD,CAAC,WAAW,EAAE,aAAa,EAAE,EAAE;gBAC7B,IAAI,WAAW,KAAK,SAAS;oBAAE,OAAO;gBACtC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;gBAChE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACpD,CAAC,CACF;SACF,CACF,CAAC;QACJ,OAAO;YACL,4CAA4C;YAC5C,4CAA4C;SAC7C,CAAC;IACJ,CAAC;IAEQ,SAAS;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEQ,SAAS,CAAC,MAAoC;QACrD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAEO,SAAS,CAAC,IAAU,EAAE,MAA8B;QAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC;QAEtC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QAED,IAAA,wCAAsB,EACpB,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EACxB,GAAG,CAAC,EAAE;YACJ,IAAI,GAAG,EAAE;gBACP,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;aAChD;QACH,CAAC,EACD,IAAI,CACL,CAAC;IACJ,CAAC;IAEO,gBAAgB;QACtB,OAAO,CAAC,QAA2B,EAAE,EAAE;YACrC,MAAM,eAAe,GAAG,IAAI,CAAC;YAC7B,OAAO,SAAS,YAAY,CAE1B,GAAG,IAAiC;gBAEpC,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACvB,eAAe,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;gBAC9C,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAEO,cAAc;QACpB,OAAO,CAAC,QAA2B,EAAE,EAAE;YACrC,MAAM,eAAe,GAAG,IAAI,CAAC;YAC7B,OAAO,SAAS,UAAU,CAExB,GAAG,IAAiC;gBAEpC,MAAM,MAAM,GAAwB,EAAE,CAAC;gBACvC,eAAe,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;gBAC9C,8BAA8B;gBAC9B,IAAI,cAAc,GAAG,KAAK,CAAC;gBAC3B,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;oBACzC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;wBAC/B,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;wBACzC,cAAc,GAAG,IAAI,CAAC;wBACtB,MAAM;qBACP;iBACF;gBACD,IAAI,CAAC,cAAc,EAAE;oBACnB,MAAM,QAAQ,GACZ,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,UAAU;wBACzC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;wBACjB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;oBAElB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;iBAClC;gBAED,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAEO,oBAAoB;QAC1B,OAAO,CAAC,QAAiC,EAAE,EAAE;YAC3C,MAAM,eAAe,GAAG,IAAI,CAAC;YAC7B,OAAO,SAAS,gBAAgB,CAE9B,GAAG,IAAiC;gBAEpC,MAAM,MAAM,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;gBAC3C,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;oBAC7B,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;wBAC3B,gCAAgC;wBAChC,IAAI;4BACF,MAAM,EACJ,wBAAwB,GACzB,GAAG,OAAO,CAAC,kCAAkC,CAAC,CAAC;4BAChD,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;4BAC9C,IAAI,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC;gCACnD,CAAC,CAAC,kBAAkB;gCACpB,CAAC,CAAC,EAAE,CAAC;4BACP,MAAM,sBAAsB,GAAG,IAAI,wBAAwB,EAAE,CAAC;4BAC9D,IAAI,kBAAkB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;gCAC5D,aAAa,GAAG,CAAC,kBAAkB,CAAC,CAAC;6BACtC;4BACD,aAAa,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;4BAC3C,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,aAAa,CAAC;yBACpC;wBAAC,OAAO,GAAG,EAAE;4BACZ,eAAe,CAAC,KAAK,CAAC,IAAI,CACxB,+FAA+F,EAC/F,GAAG,CACJ,CAAC;yBACH;qBACF;iBACF;gBACD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAAC,MAA8B;QAC1D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,qBAAqB,EAAE;YAC3C,MAAM,IAAI,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7C,IAAI,IAAI,EAAE;gBACR,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;gBACvC,IAAI,IAAA,wBAAkB,EAAC,WAAW,CAAC,EAAE;oBACnC,MAAM,MAAM,GAAG;wBACb,QAAQ,EAAE,WAAW,CAAC,OAAO;wBAC7B,OAAO,EAAE,WAAW,CAAC,MAAM;wBAC3B,WAAW,EAAE,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;qBACvD,CAAC;oBACF,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBACrD,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;oBACrC,OAAO,cAAc,CAAC;iBACvB;aACF;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAjND,wDAiNC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { context, trace, isSpanContextValid, Span } from '@opentelemetry/api';\nimport {\n  InstrumentationBase,\n  InstrumentationNodeModuleDefinition,\n  InstrumentationNodeModuleFile,\n  isWrapped,\n  safeExecuteInTheMiddle,\n} from '@opentelemetry/instrumentation';\nimport type { WinstonInstrumentationConfig } from './types';\nimport type {\n  Winston2LogMethod,\n  Winston2LoggerModule,\n  Winston3ConfigureMethod,\n  Winston3LogMethod,\n  Winston3Logger,\n} from './internal-types';\nimport { VERSION } from './version';\n\nconst winston3Versions = ['>=3 <4'];\nconst winstonPre3Versions = ['>=1 <3'];\n\nexport class WinstonInstrumentation extends InstrumentationBase {\n  constructor(config: WinstonInstrumentationConfig = {}) {\n    super('@opentelemetry/instrumentation-winston', VERSION, config);\n  }\n\n  protected init() {\n    const winstons3instrumentationNodeModuleDefinition =\n      new InstrumentationNodeModuleDefinition<{}>(\n        'winston',\n        winston3Versions,\n        moduleExports => moduleExports,\n        () => {},\n        [\n          new InstrumentationNodeModuleFile<Winston3Logger>(\n            'winston/lib/winston/logger.js',\n            winston3Versions,\n            (logger, moduleVersion) => {\n              this._diag.debug(`Applying patch for winston@${moduleVersion}`);\n              if (isWrapped(logger.prototype['write'])) {\n                this._unwrap(logger.prototype, 'write');\n              }\n              this._wrap(logger.prototype, 'write', this._getPatchedWrite());\n\n              // Wrap configure\n              if (isWrapped(logger.prototype['configure'])) {\n                this._unwrap(logger.prototype, 'configure');\n              }\n              this._wrap(\n                logger.prototype,\n                'configure',\n                this._getPatchedConfigure()\n              );\n\n              return logger;\n            },\n            (logger, moduleVersion) => {\n              if (logger === undefined) return;\n              this._diag.debug(`Removing patch for winston@${moduleVersion}`);\n              this._unwrap(logger.prototype, 'write');\n              this._unwrap(logger.prototype, 'configure');\n            }\n          ),\n        ]\n      );\n\n    const winstons2instrumentationNodeModuleDefinition =\n      new InstrumentationNodeModuleDefinition<{}>(\n        'winston',\n        winstonPre3Versions,\n        moduleExports => moduleExports,\n        () => {},\n        [\n          new InstrumentationNodeModuleFile<Winston2LoggerModule>(\n            'winston/lib/winston/logger.js',\n            winstonPre3Versions,\n            (fileExports, moduleVersion) => {\n              this._diag.debug(`Applying patch for winston@${moduleVersion}`);\n              const proto = fileExports.Logger.prototype;\n\n              if (isWrapped(proto.log)) {\n                this._unwrap(proto, 'log');\n              }\n              this._wrap(proto, 'log', this._getPatchedLog());\n\n              return fileExports;\n            },\n            (fileExports, moduleVersion) => {\n              if (fileExports === undefined) return;\n              this._diag.debug(`Removing patch for winston@${moduleVersion}`);\n              this._unwrap(fileExports.Logger.prototype, 'log');\n            }\n          ),\n        ]\n      );\n    return [\n      winstons3instrumentationNodeModuleDefinition,\n      winstons2instrumentationNodeModuleDefinition,\n    ];\n  }\n\n  override getConfig(): WinstonInstrumentationConfig {\n    return this._config;\n  }\n\n  override setConfig(config: WinstonInstrumentationConfig) {\n    this._config = config;\n  }\n\n  private _callHook(span: Span, record: Record<string, string>) {\n    const hook = this.getConfig().logHook;\n\n    if (!hook) {\n      return;\n    }\n\n    safeExecuteInTheMiddle(\n      () => hook(span, record),\n      err => {\n        if (err) {\n          this._diag.error('error calling logHook', err);\n        }\n      },\n      true\n    );\n  }\n\n  private _getPatchedWrite() {\n    return (original: Winston3LogMethod) => {\n      const instrumentation = this;\n      return function patchedWrite(\n        this: never,\n        ...args: Parameters<typeof original>\n      ) {\n        const record = args[0];\n        instrumentation._handleLogCorrelation(record);\n        return original.apply(this, args);\n      };\n    };\n  }\n\n  private _getPatchedLog() {\n    return (original: Winston2LogMethod) => {\n      const instrumentation = this;\n      return function patchedLog(\n        this: never,\n        ...args: Parameters<typeof original>\n      ) {\n        const record: Record<string, any> = {};\n        instrumentation._handleLogCorrelation(record);\n        // Inject in metadata argument\n        let isDataInjected = false;\n        for (let i = args.length - 1; i >= 0; i--) {\n          if (typeof args[i] === 'object') {\n            args[i] = Object.assign(args[i], record);\n            isDataInjected = true;\n            break;\n          }\n        }\n        if (!isDataInjected) {\n          const insertAt =\n            typeof args[args.length - 1] === 'function'\n              ? args.length - 1\n              : args.length;\n\n          args.splice(insertAt, 0, record);\n        }\n\n        return original.apply(this, args);\n      };\n    };\n  }\n\n  private _getPatchedConfigure() {\n    return (original: Winston3ConfigureMethod) => {\n      const instrumentation = this;\n      return function patchedConfigure(\n        this: never,\n        ...args: Parameters<typeof original>\n      ) {\n        const config = instrumentation.getConfig();\n        if (!config.disableLogSending) {\n          if (args && args.length > 0) {\n            // Try to load Winston transport\n            try {\n              const {\n                OpenTelemetryTransportV3,\n              } = require('@opentelemetry/winston-transport');\n              const originalTransports = args[0].transports;\n              let newTransports = Array.isArray(originalTransports)\n                ? originalTransports\n                : [];\n              const openTelemetryTransport = new OpenTelemetryTransportV3();\n              if (originalTransports && !Array.isArray(originalTransports)) {\n                newTransports = [originalTransports];\n              }\n              newTransports.push(openTelemetryTransport);\n              args[0].transports = newTransports;\n            } catch (err) {\n              instrumentation._diag.warn(\n                'OpenTelemetry Winston transport is not available, log records will not be automatically sent.',\n                err\n              );\n            }\n          }\n        }\n        return original.apply(this, args);\n      };\n    };\n  }\n\n  private _handleLogCorrelation(record: Record<string, string>) {\n    if (!this.getConfig().disableLogCorrelation) {\n      const span = trace.getSpan(context.active());\n      if (span) {\n        const spanContext = span.spanContext();\n        if (isSpanContextValid(spanContext)) {\n          const fields = {\n            trace_id: spanContext.traceId,\n            span_id: spanContext.spanId,\n            trace_flags: `0${spanContext.traceFlags.toString(16)}`,\n          };\n          const enhancedRecord = Object.assign(record, fields);\n          this._callHook(span, enhancedRecord);\n          return enhancedRecord;\n        }\n      }\n    }\n    return record;\n  }\n}\n"]}

package/build/src/internal-types.d.ts

@@ -1,6 +1,7 @@
 import type { Logger as Winston3Logger } from 'winston';
 import type { LoggerInstance as Winston2Logger, LogMethod as Winston2LogMethod } from 'winston2';
 export declare type Winston3LogMethod = Winston3Logger['write'];
+export declare type Winston3ConfigureMethod = Winston3Logger['configure'];
 export type { Winston3Logger };
 export type { Winston2LogMethod };
 export declare type Winston2LoggerModule = {

package/build/src/internal-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"internal-types.js","sourceRoot":"","sources":["../../src/internal-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Logger as Winston3Logger } from 'winston';\nimport type {\n  LoggerInstance as Winston2Logger,\n  LogMethod as Winston2LogMethod,\n} from 'winston2';\nexport type Winston3LogMethod = Winston3Logger['write'];\nexport type { Winston3Logger };\n\nexport type { Winston2LogMethod };\nexport type Winston2LoggerModule = {\n  Logger: Winston2Logger & { prototype: { log: Winston2LogMethod } };\n};\nexport type { Winston2Logger };\n"]}
+{"version":3,"file":"internal-types.js","sourceRoot":"","sources":["../../src/internal-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Logger as Winston3Logger } from 'winston';\nimport type {\n  LoggerInstance as Winston2Logger,\n  LogMethod as Winston2LogMethod,\n} from 'winston2';\nexport type Winston3LogMethod = Winston3Logger['write'];\nexport type Winston3ConfigureMethod = Winston3Logger['configure'];\nexport type { Winston3Logger };\n\nexport type { Winston2LogMethod };\nexport type Winston2LoggerModule = {\n  Logger: Winston2Logger & {\n    prototype: { log: Winston2LogMethod };\n  };\n};\nexport type { Winston2Logger };\n"]}

package/build/src/types.d.ts

@@ -2,6 +2,23 @@ import { Span } from '@opentelemetry/api';
 import { InstrumentationConfig } from '@opentelemetry/instrumentation';
 export declare type LogHookFunction = (span: Span, record: Record<string, any>) => void;
 export interface WinstonInstrumentationConfig extends InstrumentationConfig {
+    /**
+     * Whether to disable the automatic sending of log records to the
+     * OpenTelemetry Logs SDK.
+     * @default false
+     */
+    disableLogSending?: boolean;
+    /**
+     * Whether to disable the injection trace-context fields, and possibly other
+     * fields from `logHook()`, into log records for log correlation.
+     * @default false
+     */
+    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 `disableLogCorrelation` to be false.
+     */
     logHook?: LogHookFunction;
 }
 //# sourceMappingURL=types.d.ts.map

package/build/src/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Span } from '@opentelemetry/api';\nimport { InstrumentationConfig } from '@opentelemetry/instrumentation';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type LogHookFunction = (span: Span, record: Record<string, any>) => void;\n\nexport interface WinstonInstrumentationConfig extends InstrumentationConfig {\n  logHook?: LogHookFunction;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Span } from '@opentelemetry/api';\nimport { InstrumentationConfig } from '@opentelemetry/instrumentation';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type LogHookFunction = (span: Span, record: Record<string, any>) => void;\n\nexport interface WinstonInstrumentationConfig extends InstrumentationConfig {\n  /**\n   * Whether to disable the automatic sending of log records to the\n   * OpenTelemetry Logs SDK.\n   * @default false\n   */\n  disableLogSending?: boolean;\n\n  /**\n   * Whether to disable the injection trace-context fields, and possibly other\n   * fields from `logHook()`, into log records for log correlation.\n   * @default false\n   */\n  disableLogCorrelation?: boolean;\n\n  /**\n   * A function that allows injecting additional fields in log records. It is\n   * called, as `logHook(span, record)`, for each log record emitted in a valid\n   * span context. It requires `disableLogCorrelation` to be false.\n   */\n  logHook?: LogHookFunction;\n}\n"]}

package/build/src/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.35.0";
+export declare const VERSION = "0.36.0";
 //# sourceMappingURL=version.d.ts.map

package/build/src/version.js

@@ -17,5 +17,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // this is autogenerated file, see scripts/version-update.js
-exports.VERSION = '0.35.0';
+exports.VERSION = '0.36.0';
 //# sourceMappingURL=version.js.map

package/build/src/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4DAA4D;AAC/C,QAAA,OAAO,GAAG,QAAQ,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// this is autogenerated file, see scripts/version-update.js\nexport const VERSION = '0.35.0';\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4DAA4D;AAC/C,QAAA,OAAO,GAAG,QAAQ,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// this is autogenerated file, see scripts/version-update.js\nexport const VERSION = '0.36.0';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentelemetry/instrumentation-winston",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "description": "OpenTelemetry instrumentation for winston",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
@@ -45,9 +45,10 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.3.0",
-    "@opentelemetry/context-async-hooks": "^1.8.0",
-    "@opentelemetry/sdk-trace-base": "^1.8.0",
-    "@opentelemetry/sdk-trace-node": "^1.8.0",
+    "@opentelemetry/context-async-hooks": "^1.21.0",
+    "@opentelemetry/sdk-trace-base": "^1.21.0",
+    "@opentelemetry/sdk-trace-node": "^1.21.0",
+    "@opentelemetry/winston-transport": "^0.2.0",
     "@types/mocha": "7.0.2",
     "@types/node": "18.6.5",
     "@types/sinon": "10.0.18",
@@ -56,15 +57,15 @@
     "nyc": "15.1.0",
     "rimraf": "5.0.5",
     "sinon": "15.2.0",
-    "test-all-versions": "6.0.0",
+    "test-all-versions": "6.1.0",
     "ts-mocha": "10.0.0",
     "typescript": "4.4.4",
     "winston": "3.3.3",
     "winston2": "npm:winston@2.4.7"
   },
   "dependencies": {
-    "@opentelemetry/instrumentation": "^0.49.1"
+    "@opentelemetry/instrumentation": "^0.50.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-winston#readme",
-  "gitHead": "fcea8ca0c83cb1dcd8ac736e5ea4d22ff20dc982"
+  "gitHead": "17a0bc1da3baa472ba9b867eee3c60730cc130fb"
 }