Update instrumentation library naming guidance to avoid conflicts between external and otel instrumentations #4187
Conversation
This file contains hidden or 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
…h otel-instrumentations
lmolkova
changed the title
austinlparker
approved these changes
Aug 16, 2024
|
sgtm. we can't really force people to change existing packages but would appreciate if they did. |
yurishkuro
reviewed
Aug 16, 2024
|
cijothomas
approved these changes
Aug 16, 2024
xrmx
approved these changes
Aug 19, 2024
lzchen
approved these changes
Aug 19, 2024
jsuereth
approved these changes
Aug 19, 2024
arminru
approved these changes
Aug 20, 2024
carlosalberto
approved these changes
Aug 20, 2024
|
I plan to merge it on Wed 8/28 unless the will be any objections. |
carlosalberto
pushed a commit
to carlosalberto/opentelemetry-specification
that referenced
this pull request
Oct 31, 2024
…ween external and otel instrumentations (open-telemetry#4187) Some package managers (PyPi) don't provide means to reserve namespaces for projects. We also have a number of **external** instrumentation libraries in python that follow current guidance and use `opentelemetry-instrumentation-{component}` naming pattern. These libraries are hard to distinguish from otel-authored ones. Also, when someone (legitimately following existing guidance) creates an external instrumentation package like this, it blocks our ability to have OTel-authored instrumentation with this 'good' name. See open-telemetry/opentelemetry-python-contrib#2759 (comment) for real-life example. ## Changes This PR changes the recommendation to: - otel authored instrumentation should use `opentelemetry-instrumentation-*` pattern - external instrumentation should not use this pattern and should prefix lib name with their company/project/etc name * ~~[ ] Related issues #~~ * ~~[ ] Related [OTEP(s)](https://github.com/open-telemetry/oteps) #~~ * ~~[ ] Links to the prototypes (when adding or changing features)~~ * [x] [`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md) file updated for non-trivial changes * ~~[ ] [`spec-compliance-matrix.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md) updated if necessary~~ --------- Co-authored-by: Armin Ruech <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
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.
Some package managers (PyPi) don't provide means to reserve namespaces for projects. We also have a number of external instrumentation libraries in python that follow current guidance and use
opentelemetry-instrumentation-{component}naming pattern.These libraries are hard to distinguish from otel-authored ones. Also, when someone (legitimately following existing guidance) creates an external instrumentation package like this, it blocks our ability to have OTel-authored instrumentation with this 'good' name.
See open-telemetry/opentelemetry-python-contrib#2759 (comment) for real-life example.
Changes
This PR changes the recommendation to:
opentelemetry-instrumentation-*pattern[ ] Related issues #[ ] Related OTEP(s) #[ ] Links to the prototypes (when adding or changing features)CHANGELOG.mdfile updated for non-trivial changes[ ]spec-compliance-matrix.mdupdated if necessary