Clarify unit annotation format for metric semantic conventions #2719
Labels
area:semantic-conventions
Related to semantic conventions
help wanted
Extra attention is needed
[label deprecated] triaged-accepted
[label deprecated] Issue triaged and accepted by OTel community, can proceed with creating a PR
release:required-for-ga
Must be resolved before GA release, or nice to have before GA
spec:metrics
Related to the specification/metrics directory
The semantic conventions for metrics currently use both spaces and underscores in unit annotations consisting of multiple words. Additionally, we have examples where the spaces between words are just omitted.
Before calling any of the metrics semantic conventions stable, we should add guidance on what's preferred and align the existing conventions to be consistent.
Also, as per the UCUM standard, both
1
and{count}
are considered equivalent, which might lead to inconsistent conventions. A preference for either of them could also be laid out by the OTel spec.Examples
opentelemetry-specification/specification/metrics/semantic_conventions/instrumentation/kafka.md
Lines 40 to 42 in 534d456
opentelemetry-specification/specification/metrics/semantic_conventions/instrumentation/kafka.md
Lines 78 to 83 in 534d456
opentelemetry-specification/specification/metrics/semantic_conventions/instrumentation/kafka.md
Line 65 in 534d456
opentelemetry-specification/specification/metrics/semantic_conventions/faas-metrics.md
Line 43 in 534d456
The text was updated successfully, but these errors were encountered: