@opentelemetry/winston-transport

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');


// 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);

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

• winston versions >=3.0.0 <4

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.10.0

:bug: Bug Fix

• #186 [size/XS] fix: fixes broken readme links (@michaelgoin)

:tada: New Plugins

• #171 feat: Hapi auto-instrumentation (@carolinee21)
• #144 feat: adding Koa instrumentation (@carolinee21)

:rocket: Enhancement

• Other
  • #183 [mysql] implement semantic conventions (@naseemkullah)
  • #196 fix: new version with TextMapPropagator interface (@jufab)
  • #184 chore: moved plugins-node-all into contrib repo from opentelemetry-js (@michaelgoin)
  • #187 [mongodb] implement semantic db conventions (@naseemkullah)
  • #172 [Plugin User Interaction]: Improve causality of spans from bubbled events (@johnbley)
  • #164 feat: Add React Plugin (@thgao)
  • #170 fix: various compilation errors (@naseemkullah)
• opentelemetry-test-utils
  • #167 ioredis and redis DB semantic conventions (@naseemkullah)

:house: Internal

• #194 Ioredis cleanup (@naseemkullah)
• #195 redis cleanup (@naseemkullah)
• #192 Handful of document-load fixes (@johnbley)
• #191 Zone.js fixed failing build (@obecny)
• #174 feat(opentelemetry-plugin-pg): omit pg.values by default (@sergioregueira)

Committers: 9

• Bartlomiej Obecny (@obecny)
• John Bley (@johnbley)
• Julien Fabre (@jufab)
• Michael Goin (@michaelgoin)
• Naseem (@naseemkullah)
• Sergio Regueira (@sergioregueira)
• Shivkanya Andhare (@shivkanya9146)
• Tina Gao (@thgao)
• @carolinee21