docs: add instrumentation naming convention to contributing guide#4754
Open
krrishapatel wants to merge 1 commit into
Open
docs: add instrumentation naming convention to contributing guide#4754krrishapatel wants to merge 1 commit into
krrishapatel wants to merge 1 commit into
Conversation
xrmx
requested changes
Jul 2, 2026
xrmx
left a comment
xrmx
left a comment
Contributor
There was a problem hiding this comment.
This contains unrelated changes
github-project-automation
Bot
moved this to Reviewed PRs that need fixes
in Python PR digest
Add a note under the instrumentation guidelines that tracers and meters should be obtained using the top-level instrumentation package name as a fixed string (e.g. "opentelemetry.instrumentation.requests") rather than __name__, which varies by submodule. Assisted-by: Claude Opus 4.6
krrishapatel
force-pushed
the
docs/instrumentation-naming-convention
branch
from
65484c8 to
dd792c1
Compare
Author
|
Thanks @xrmx — you're right, the logging README change was unrelated. I've rebased to remove it; this PR now only touches |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
Adds a note to the instrumentation guidelines section of CONTRIBUTING.md documenting that instrumentations should use their top-level package name (e.g.
"opentelemetry.instrumentation.requests") as a fixed string when obtaining a tracer or meter, rather than__name__.Fixes #910
Type of change
How Has This Been Tested?
Documentation-only change.
Does This PR Require a Core Repo Change?
Assisted-by: Claude Opus 4.6