fix(instrumentation): drop diag.debug on InstrumentationBase#init not returning any modules #4925
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pichlermarc
approved these changes
Aug 19, 2024
Zirak
pushed a commit
to Zirak/opentelemetry-js
that referenced
this pull request
Sep 14, 2024
… returning any modules (open-telemetry#4925)
This was referenced Sep 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: open-telemetry/opentelemetry-js-contrib#2237
Refs: #3308
Back in #3308 a diag.warn
No modules instrumentation has been defined for {instr}, nothing with be patchedwas reduced to being a diag.debug to avoid confusion for users. The aws-lambda instrumentation can reasonably not patching anything.Another more recent case: instrumentation-undici uses InstrumentationBase but its
init()doesn't return any modules to patch because it uses diagnostics-channels to do its instrumentation. This is a second example where it is totally reasonable for an instrumentation to not return any modules for patching frominit(). Given it is reasonable to do so, I don't think thediag.debug()is worth it. Sure, it theoretically might catch a programming error in an instrumentation, but I don't think that merits a diag.debug that can cause user confusion. E.g. in open-telemetry/opentelemetry-js-contrib#2237