docs(instrumentation): better docs for supportedVersions option #4693
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
|
related: #4694 |
dyladan
approved these changes
May 10, 2024
pichlermarc
approved these changes
May 13, 2024
experimental/packages/opentelemetry-instrumentation/src/types.ts
Outdated
Show resolved
Hide resolved
pichlermarc
reviewed
May 13, 2024
experimental/packages/opentelemetry-instrumentation/src/types.ts
Outdated
Show resolved
Hide resolved
This was referenced Jun 27, 2024
Closed
Closed
This was referenced Jul 10, 2024
Merged
This was referenced Jul 12, 2024
Closed
Closed
This was referenced Sep 12, 2024
Open
Zirak
pushed a commit
to Zirak/opentelemetry-js
that referenced
this pull request
Sep 14, 2024
…-telemetry#4693) * docs(instrumentation): better docs for supportedVersions option * docs: add recomundation to bound major version * revert: Instrumentation class changes * docs: add recommendation in both places * docs: lint fix * chore: CHANGLOG * Update experimental/packages/opentelemetry-instrumentation/src/types.ts * Update experimental/packages/opentelemetry-instrumentation/src/types.ts --------- Co-authored-by: Marc Pichler <[email protected]>
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.
This PR improves the documentation of the
supportedVersionsoption onInstrumentationModuleDefinitionandInstrumentationModuleFile:This PR is only to document existing behavior, which is something we might want to consider. I think it is unhealthy for instrumentations to attempt patching any version by default when the array is empty, as it is never guaranteed that major version patches will work out of the box, and we don't want to harm user environment stability.