open-telemetry / open-telemetry/opentelemetry-python
Metric naming conventions reasoning
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 19
Description
Describe your environment I am currently using the Python SDK for a sample app that creates metrics instruments like Counter, UpDownCounter, and etc. When my metrics were exported to Cloudwatch, I noticed that the metric names are all lowercase so I checked the SDK and found here that metric names are converted to all lowercase for some reason. I was wondering why the metric names are converted to lowercase, and is this the naming convention we should follow? If so, should this be documented somewhere? Thank you.
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 linked metric instrument implementation in opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/instrument.py and review the existing metric naming documentation. Determine whether lowercase conversion and its rationale are established, then document the convention or clarify the expected behavior; done means the naming guidance is explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, observability-sre
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100