NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: better document how to track metrics in Prometheus
Open
Nobody has claimed this yet.
doc
- Dominant language
- Python
- Stars
- 3k
- Forks
- 349
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
How would you describe the priority of this documentation request
None
Please provide a link or source to the relevant docs
https://github.com/NVIDIA/nv-ingest/blob/main/docs/telemetry.md
Describe the problems in the documentation
It isn’t clear how to track metrics in prometheus. For example, what is source_to_sink_mean? I was not able to get any visualization when I selected that metric.
(Optional) Propose a correction or improvement
No response
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 docs/telemetry.md and inspect the explanation and visualization guidance for source_to_sink_mean in Prometheus. Clarify what the metric represents and how users should select it to obtain a visualization; done when the documentation explains both tracking the metric and viewing it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- prometheus
- Domain
- documentation, observability-sre
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100