Skip to content
Merged
Changes from 2 commits
Commits
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
14 changes: 10 additions & 4 deletions docs/general/naming.md
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,20 @@ 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).
by the namespace then the metric SHOULD be named `count` within that namespace.

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`.
Comment thread
joaopgrassi marked this conversation as resolved.
Outdated

It's not always necessary to use `count`.
Comment thread
ChrsMark marked this conversation as resolved.
Outdated
For example, a suffix like `active` should be enough when the metric represents the number of concepts
in `active` state, i.e. `cicd.pipeline.run.active`.

What is required, is to not pluralize UpDownCounter metric names.

#### Do not use `total`

Expand Down
Loading