fix(instrumentation): ensure .setConfig() results in config.enabled defaulting to true #4941
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
…efaulting to true
Before this change an instrumentation instance's config, as returned
from .getConfig(), would include {enabled: true} after construction,
`new MyInstrumentation()`; but would not include 'enabled' after
`.setConfig({})`. That inconsistency could cause bugs in usage of
`this.getConfig().enabled`.
trentm
added a commit
to david-luna/opentelemetry-js-contrib
that referenced
this pull request
Aug 21, 2024
…s this._enabled state can be maintained; explain some of the confusion with enabled state handling in InstrumentationBase and go back to using config.enabled to decide whether to generate instrumentation
One tweak on using config.enabled is that I'm checking `!== false` in
case the config object doesn't have "enabled" defined -- currently
possible if `instr.setConfig({})` is called. I opened
open-telemetry/opentelemetry-js#4941 for that.
pichlermarc
approved these changes
Aug 22, 2024
Zirak
pushed a commit
to Zirak/opentelemetry-js
that referenced
this pull request
Sep 14, 2024
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.
Before this change an instrumentation instance's config, as returned
from .getConfig(), would include {enabled: true} after construction,
new MyInstrumentation(); but would not include 'enabled' after.setConfig({}). That inconsistency could cause bugs in usage ofthis.getConfig().enabled.