Skip to content

Commit

Permalink
Clarify when "count" is used instead of pluralization
Browse files Browse the repository at this point in the history
The existing pluralization rule does not explain why we have
metrics like `system.processes.count`.

This adds a paragraph to explain when `count` is used instead
of pluralization.

Resolves #2553
  • Loading branch information
tigrannajaryan committed Jun 9, 2022
1 parent 013a0f1 commit f6e033d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions specification/metrics/semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,17 @@ should not be pluralized, even if many data points are recorded.
* `system.paging.faults`, `system.disk.operations`, and `system.network.packets`
should be pluralized, even if only a single data point is recorded.

#### Exception

If the value being recorded represents the count of concepts signified
by the namespace then the metric should be named `count` (within its namespace).
The pluralization rule does not apply in this case.

For example if we have a namespace `system.processes` which contains all metrics related
to the processes then to represent the count of the processes we can have a metric named
`system.processes.count`. The suffix `count` here indicates that it is the count of
`system.processes`.

## General Metric Semantic Conventions

The following semantic conventions aim to keep naming consistent. They
Expand Down

0 comments on commit f6e033d

Please sign in to comment.