OpenTelemetry transport for winston
This module provides a Transport for winston
module to send Winston logging to the OpenTelemetry Logging SDK.
Compatible with OpenTelemetry JS API and SDK 1.0+
.
Installation
npm install --save @opentelemetry/winston-transport
Usage
This package exports the Winston transport class that is used to send records to the
OpenTelemetry Logs SDK. It can be used directly when configuring a Winston logger. If using
@opentelemetry/instrumenation-winston
package there is no need to instantiate the transport as the instrumentation will take care of that.
For example:
const logsAPI = require('@opentelemetry/api-logs');
const {
LoggerProvider,
SimpleLogRecordProcessor,
ConsoleLogRecordExporter,
} = require('@opentelemetry/sdk-logs');
const { OpenTelemetryTransportV3 } = require('@opentelemetry/winston-transport');
const winston = require('winston');
const loggerProvider = new LoggerProvider();
loggerProvider.addLogRecordProcessor(
new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())
);
logsAPI.logs.setGlobalLoggerProvider(loggerProvider);
const logger = winston.createLogger({
level: 'info',
transports: [
new winston.transports.Console(),
new OpenTelemetryTransportV3()
]
});
[!IMPORTANT]
Logs will be duplicated if @opentelemetry/winston-transport
is added as a transport in winston
and @opentelemetry/instrumentation-winston
is configured with disableLogSending: false
.
Supported versions
Useful links
License
Apache 2.0 - See LICENSE for more information.