open-telemetry / open-telemetry/opentelemetry-python
Automatically add `/v1/metrics` to endpoints
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 19
Description
Is your feature request related to a problem?
In other otel libraries (go and javascript), when you provide an endpoint the library will automatically append /v1/metrics to it. This has cause some confusion on our teams as to how to properly provide endpoints.
(This has been previously reported as a bug in https://github.com/open-telemetry/opentelemetry-python/issues/3200)
Describe the solution you'd like
If /v1/metrics is missing from the endpoint, it should be added.
Describe alternatives you've considered
n/a
Additional Context
Ideally the otel libraries should work similarly to each other to help prevent confusion
Would you like to implement a fix?
Yes
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 by locating the metrics exporter endpoint handling and its existing tests in the repository. Check how endpoints are currently normalized, then add coverage showing that a missing /v1/metrics suffix is added while an existing suffix is preserved. Done means the endpoint behavior is consistent with the issue and the relevant tests pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- observability-sre
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100