Document available metrics and clarify OTEL vs Prometheus usage
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2.2k
- Forks
- 300
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 184
Description
Document the metrics emitted by the system and clarify which ones are available via OpenTelemetry (Otel) versus Prometheus.
The current set of metrics is generally sufficient, but some are not fully exposed through Prometheus which can be confusing. We should consider consolidating on Otel as the primary metrics path and deprecating the Prometheus /metrics endpoint if appropriate and ensure the documentation reflects this clearly.
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 inventorying the metrics emitted by the system and comparing their OpenTelemetry and Prometheus exposure, including the /metrics endpoint. Document which metrics each path provides, clarify the intended primary path, and record whether deprecating /metrics is appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, prometheus
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100