open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

`.count` metric naming convention only applies to UpDownCounters (#107)

This commit is contained in:
Trask Stalnaker 2023-07-25 11:00:55 -07:00 committed by GitHub
parent fbf46a1302
commit a5509c690a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -9,6 +9,9 @@ release.
- Fix the unit of metric.process.runtime.jvm.system.cpu.load_1m to be {run_queue_item} - Fix the unit of metric.process.runtime.jvm.system.cpu.load_1m to be {run_queue_item}
([#95](https://github.com/open-telemetry/semantic-conventions/pull/95)) ([#95](https://github.com/open-telemetry/semantic-conventions/pull/95))
- Update `.count` metric naming convention so that it only applies to UpDownCounters,
and add that `.total` should not be used by either Counters or UpDownCounters
([#107](https://github.com/open-telemetry/opentelemetry-specification/pull/107))
## v1.21.0 (2023-07-13) ## v1.21.0 (2023-07-13)

20
docs/general/metrics.md
View File

@ -12,8 +12,10 @@ aliases: [docs/specs/semconv/general/metrics-general]
- [General Guidelines](#general-guidelines) - [General Guidelines](#general-guidelines)
* [Name Reuse Prohibition](#name-reuse-prohibition) * [Name Reuse Prohibition](#name-reuse-prohibition)
* [Units](#units) * [Units](#units)
* [Pluralization](#pluralization) * [Naming rules for Counters and UpDownCounters](#naming-rules-for-counters-and-updowncounters)
+ [Use `count` Instead of Pluralization](#use-count-instead-of-pluralization) + [Pluralization](#pluralization)
+ [Use `count` Instead of Pluralization for UpDownCounters](#use-count-instead-of-pluralization-for-updowncounters)
+ [Do not use `total`](#do-not-use-total)
- [General Metric Semantic Conventions](#general-metric-semantic-conventions) - [General Metric Semantic Conventions](#general-metric-semantic-conventions)
* [Instrument Naming](#instrument-naming) * [Instrument Naming](#instrument-naming)
* [Instrument Units](#instrument-units) * [Instrument Units](#instrument-units)
@ -99,7 +101,9 @@ When building components that interoperate between OpenTelemetry and a system
using the OpenMetrics exposition format, use the using the OpenMetrics exposition format, use the
[OpenMetrics Guidelines](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/compatibility/prometheus_and_openmetrics.md). [OpenMetrics Guidelines](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/compatibility/prometheus_and_openmetrics.md).
### Pluralization ### Naming rules for Counters and UpDownCounters
#### Pluralization
Metric names SHOULD NOT be pluralized, unless the value being recorded Metric names SHOULD NOT be pluralized, unless the value being recorded
represents discrete instances of a represents discrete instances of a
@ -114,7 +118,7 @@ should not be pluralized, even if many data points are recorded.
* `system.paging.faults`, `system.disk.operations`, and `system.network.packets` * `system.paging.faults`, `system.disk.operations`, and `system.network.packets`
should be pluralized, even if only a single data point is recorded. should be pluralized, even if only a single data point is recorded.
#### Use `count` Instead of Pluralization #### Use `count` Instead of Pluralization for UpDownCounters
If the value being recorded represents the count of concepts signified 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 its namespace).
@ -125,6 +129,14 @@ to the processes then to represent the count of the processes we can have a metr
`system.processes.count`. The suffix `count` here indicates that it is the count of `system.processes.count`. The suffix `count` here indicates that it is the count of
`system.processes`. `system.processes`.
#### Do not use `total`
UpDownCounters SHOULD NOT use `_total` because then they will look like
monotonic sums.
Counters SHOULD NOT append `_total` either because then their meaning will
be confusing in delta backends.
## General Metric Semantic Conventions ## General Metric Semantic Conventions
**Status**: [Mixed][DocumentStatus] **Status**: [Mixed][DocumentStatus]