Skip to content

docs(instrumentation-winston): Clarify the duplicate logging workaround #2831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trentm merged 5 commits into from
Jul 10, 2025
Merged

docs(instrumentation-winston): Clarify the duplicate logging workaround #2831

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8772f4c
feat: Clarify the duplicate logging workaround
vordimous May 18, 2025
0cc7305
Update plugins/node/opentelemetry-instrumentation-winston/README.md
vordimous Jul 8, 2025
bedea1a
Update plugins/node/opentelemetry-instrumentation-winston/README.md
vordimous Jul 8, 2025
8e1cf50
Merge branch 'main' into patch-1
vordimous Jul 8, 2025
3c147e2
Merge branch 'main' into patch-1
trentm Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion plugins/node/opentelemetry-instrumentation-winston/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,25 @@ const logger = winston.createLogger({
```

> [!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`.
> Logs will be **duplicated** if `OpenTelemetryTransportV3` is explicitly added as a Winston logger transport **and** `@opentelemetry/instrumentation-winston` is active with the [Log sending](#log-sending) feature (the default). If you are both using `OpenTelemetryTransportV3` and instrumentation-winston, be sure to either disable instrumentation-winston completely, or disable its Log sending feature (`disableLogSending: false`). For examle:
>
> ```js
> const { WinstonInstrumentation } = require('@opentelemetry/instrumentation-winston');
> const { registerInstrumentations } = require('@opentelemetry/instrumentation');
> registerInstrumentations({
> instrumentations: [
> new WinstonInstrumentation({
> disableLogSending: true
> }),
> ],
> });
> const { OpenTelemetryTransportV3 } = require('@opentelemetry/winston-transport');
> // Winston import must be after the WinstonInstrumentation creation
> const winston = require('winston');
>
> // ...
> const logger = winston.createLogger(...);
> ```

## Semantic Conventions

Expand Down