Best Practice Docs Don't Call Out the Importance of Job Label
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
https://prometheus.io/docs/practices/naming/ and https://prometheus.io/docs/practices/rules/ should call out the importance of the job label, particularly in a multi-tenant prometheus installation.
https://prometheus.io/docs/practices/naming/ does not mention the job label at all.
https://prometheus.io/docs/practices/rules does mention
Always specify a without clause with the labels you are aggregating away. This is to preserve all the other labels such as job, which will avoid conflicts and give you more useful metrics and alerts.
and all it's examples include an explicit job label
But that's about as explicit as it gets.
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
Read the naming and rules pages linked in the issue, especially the existing discussion of the job label and aggregation examples. Update the best-practices guidance to explain why preserving job matters, particularly in multi-tenant Prometheus installations, and verify both pages consistently communicate that point.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100