Naming conventions: _total vs. _count
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
The Metric and label naming documentation page states that "an accumulating count has a total as a suffix".
The Histograms and summaries best practice page however uses _count as the suffix for a counter.
Are these two recommendations not contradictory? Is the count+sum pair an exception to the general counter case, and thus warrants its own suffix? (If that's the case, it would probably make sense to mention that in the "Metric and label naming" page).
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 linked Metric and label naming and Histograms and summaries documentation pages first, comparing their guidance on _total and _count. Resolve whether the count-and-sum convention is an exception, then update the relevant wording so the recommendations are consistent and the relationship is explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- prometheus
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100