Logger prints unformatted strings after ComponentLogger addition

[rauno56]

Please answer these questions before submitting a bug report.

Versions

• @opentelemetry/api@1.0.2,
• @opentelemetry/instrumentation@0.24.0
• node@14

Please provide the code you used to set up the OpenTelemetry SDK

HTTP example with log level set to DEBUG works.

What did you do?

I'm running an example with HTTP instrumentation enabled. Logs show:

@opentelemetry/instrumentation-http %s instrumentation outgoingRequest http
@opentelemetry/instrumentation-http http.ClientRequest return request
@opentelemetry/instrumentation-http %s instrumentation outgoingRequest http
@opentelemetry/instrumentation-http http.ClientRequest return request
@opentelemetry/instrumentation-http %s instrumentation incomingRequest http

What did you expect to see?

Something like:

@opentelemetry/instrumentation-http outgoingRequest
@opentelemetry/instrumentation-http http.ClientRequest return request
@opentelemetry/instrumentation-http incomingRequest

Additional context

console.log only formats the first argument. Since ComponentLogger forces the first argument to now be the namespace it breaks all code that uses printf-like string formatting.
To bring back the functionality to its previous state, we should util.format the args before passing them to logProxy in DiagComponentLogger. However, that would force this behaviour on all the loggers, which I'd personally be cautious of. Unless any of the maintainers are strongly for it I'd just replace the usages of string formatting with template literals(`my log ${var}`) instead, or use util.format before passing the arguments to the logger.

Steps

• Remove unnecessary tagging from logs from HTTP instrumentation;
• Discussion: Should printf-like string formatting be forced to all loggers?

[alisabzevari]

I just checked the usage of %s and %d in the project and it seems to be fairly easy to replace all of them with template literals. I would also vote for using template literals since it is more like idiomatic Javascript.
Let me know if you agree, then I will create a PR to fix this.

[rauno56]

You mean to replace usages of %s and %d in the instrumentations(namely HTTP instrumentation) with template literals? I agree.

[alisabzevari]

Yes, I searched in all the packages but we can also change it only in instrumentation packages.

[rauno56]

Everything that uses ComponentLogger has this problem, so, at least eventually, all of those should be changed.

[PaurushGarg]

@dyladan - please assign me this issue. I am working in @alolita team.
Tag: @alolita