Add documentation for `/metrics`?
Open
- Dominant language
- Go
- Stars
- 4k
- Forks
- 818
- Avg merge
- 1h 14m
- Merged PRs (30d)
- 1
Description
The endpoint to expose metrics for Prometheus was added in this PR - https://github.com/linkedin/Burrow/pull/628/files. However the documentation was not added. This hid the feature from the users merely reading the documentation.
I don't have access to add edit the Wiki, hence creating this issue.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading PR #628 and the existing `/metrics` endpoint, then check the repository documentation or Wiki structure for the appropriate location. Done means users can find documentation explaining that Burrow exposes metrics for Prometheus and how to use the endpoint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, prometheus
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100