Skip to content

[chore] Clarify .count for updowncounters guidance #2317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lmolkova merged 4 commits into from
Jul 1, 2025
Merged

[chore] Clarify .count for updowncounters guidance #2317

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1acc6c9
[chore] Clarify .count for updowncounters guidance
ChrsMark Jun 2, 2025
1ffe3c9
Change guidance to require non pluralized updowncounters
ChrsMark Jun 24, 2025
48cb2e9
apply review suggestion
ChrsMark Jun 27, 2025
0610fb3
review comments
ChrsMark Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/general/naming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ aliases: [attribute-naming]
- [Metrics](#metrics)
- [Naming rules for counters and UpDownCounters](#naming-rules-for-counters-and-updowncounters)
- [Pluralization](#pluralization)
- [Use `count` instead of pluralization for UpDownCounters](#use-count-instead-of-pluralization-for-updowncounters)
- [Do not pluralize UpDownCounter names](#do-not-pluralize-updowncounter-names)
- [Do not use `total`](#do-not-use-total)
- [Instrument naming](#instrument-naming)
- [Client and server metrics](#client-and-server-metrics)
Expand Down Expand Up @@ -288,14 +288,14 @@ Examples:
- `system.paging.faults`, `system.disk.operations`, and `system.network.packets`
should be pluralized, even if only a single data point is recorded.

#### Use `count` instead of pluralization for UpDownCounters
#### Do not pluralize UpDownCounter names

If the value being recorded represents the count of concepts signified
by the namespace then the metric should be named `count` (within its namespace).
UpDownCounter names SHOULD NOT be pluralized.

For example if we have a namespace `system.process` which contains all metrics related
to the processes then to represent the count of the processes we can have a metric named
`system.process.count`.
`system.process.count` instead of `system.processes`. Similarly, `cicd.pipeline.run.active` is preferred
over the `cicd.pipeline.active_runs`.

#### Do not use `total`

Expand Down
Loading