open-telemetry / open-telemetry/opentelemetry-python-contrib
Provide guidance for consistent instrumentation name
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
Currently just about every instrumentation library uses __name__ as its instrumentation name. It would be good to provide guidance in the contributing documentation around what parameter should be used here.
Are we recommending a single name for all the modules/classes in an instrumentation or are we ok with different instrumentation names for different modules within the same instrumentation library?
This is to clarify: https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1012#discussion_r843305912
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the contributing documentation and read the discussion in pull request #1012 referenced by the issue. Clarify whether an instrumentation library should use one name or allow different names across modules or classes, then document the agreed guidance in the contributing documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100