How to use suppressOverrideMessage flag with @opentelemetry/auto-instrumentations-node

[PrimeDominus]

I noticed the addition of the suppressOverrideMessage flag in #3366 but I'm confused as to how to use it with @opentelemetry/auto-instrumentations-node and pino.

Can someone please share an example of how to use it?

• This only affects the JavaScript OpenTelemetry library
• This may affect other libraries, but I would like to get opinions here first

[pichlermarc]

Hi, thanks for reaching out.

Hmm, I'm not sure I fully understand - at which point are you trying to suppress the override message? 🤔
Do you call diag.setLogger() somewhere or is @opentelemetry/auto-instrumentations-node doing that?

[PrimeDominus]

As described in the @opentelemetry/auto-instrumentations-node README, we can automatically instrument most things, including pino, by setting some environment variables and running our app with NODE_OPTIONS="--require @opentelemetry/auto-instrumentations-node/register", or we can manually configure it in a file like this.

Both ways work, however I notice when using pino (or possibly another logger) for logging, we get the following when our app starts:

Current logger will be overwritten from Error
     at DiagAPI.setLogger (/home/app/node_modules/.pnpm/@opentelemetry+api@1.9.0/node_modules/@opentelemetry/api/build/src/api/diag.js:65:37)
     at new NodeSDK (/home/app/node_modules/.pnpm/@opentelemetry+sdk-node@0.57.2_@opentelemetry+api@1.9.0/node_modules/@opentelemetry/sdk-node/build/src/sdk.js:130:24)
     at Object.<anonymous> (/home/app/node_modules/.pnpm/@opentelemetry+auto-instrumentations-node@0.56.1_@opentelemetry+api@1.9.0/node_modules/@opentelemetry/auto-instrumentations-node/build/src/register.js:22:13)
     at Module._compile (node:internal/modules/cjs/loader:1554:14)
     at Object..js (node:internal/modules/cjs/loader:1706:10)
     at Module.load (node:internal/modules/cjs/loader:1289:32)
     at Function._load (node:internal/modules/cjs/loader:1108:12)
     at TracingChannel.traceSync (node:diagnostics_channel:322:14)
     at wrapModuleLoad (node:internal/modules/cjs/loader:220:24)
     at Module.<anonymous> (node:internal/modules/cjs/loader:1311:12)

I believe this is the warning/error discussed in #3366 and why the suppressOverrideMessage flag was implemented. So my question is: If using @opentelemetry/auto-instrumentations-node with any of the prescribed ways in its respective README, how do we then use the suppressOverrideMessage flag if our app uses pino for logging?

[pichlermarc]

Hmm, AFAIK @opentelemetry/instrumentation-pino does not auto-register a diagnostics logger. The feature in open-telemetry/opentelemetry-js#3366 is intended for the case that someone manually re-registers a diagnostics logger and they want to suppress the message.

I suppose you're seeing this message as both @opentelemetry/auto-instrumentations-node/register and new NodeSDK() register a logger, and the one from NodeSDK() does not set that flag, so it always re-registers the one that @opentelemetry/auto-instrumentations-node/register has already set.

The way to fix this would be to:

• introduce a new option to manually configure the logger via code in @opentelemetry/sdk-node, which supports an explicit "do not set" semantic (like passing null to the option)
• use that "do-not-set" option in @opentelemetry/auto-instrumentations-node/register to avoid re-registering it.

[pichlermarc]

I marked this as a bug and priority:p4 (logspam that can be safely ignored)