Skip to content

Commit b32b0d9

Browse files
authored
[chore] Clarify .count for updowncounters guidance (#2317)
Signed-off-by: ChrsMark <[email protected]>
1 parent c338232 commit b32b0d9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/general/naming.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ aliases: [attribute-naming]
2424
- [Metrics](#metrics)
2525
- [Naming rules for counters and UpDownCounters](#naming-rules-for-counters-and-updowncounters)
2626
- [Pluralization](#pluralization)
27-
- [Use `count` instead of pluralization for UpDownCounters](#use-count-instead-of-pluralization-for-updowncounters)
27+
- [Do not pluralize UpDownCounter names](#do-not-pluralize-updowncounter-names)
2828
- [Do not use `total`](#do-not-use-total)
2929
- [Instrument naming](#instrument-naming)
3030
- [Client and server metrics](#client-and-server-metrics)
@@ -288,14 +288,14 @@ Examples:
288288
- `system.paging.faults`, `system.disk.operations`, and `system.network.packets`
289289
should be pluralized, even if only a single data point is recorded.
290290

291-
#### Use `count` instead of pluralization for UpDownCounters
291+
#### Do not pluralize UpDownCounter names
292292

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

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

300300
#### Do not use `total`
301301

0 commit comments

Comments
 (0)