Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark "Instrumentation Units" and "Instrumentation Types" sections of the general metric semantic conventions as stable #3294

Merged
merged 8 commits into from
Apr 14, 2023
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ release.

### Semantic Conventions

- Mark "Instrumentation Units" and "Instrumentation Types" sections of the general
metric semantic conventions as stable
([#3294](https://github.com/open-telemetry/opentelemetry-specification/pull/3294))

### Compatibility

### OpenTelemetry Protocol
Expand Down
10 changes: 6 additions & 4 deletions specification/metrics/semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ linkTitle: Semantic Conventions
<!-- omit in toc -->
# Metrics Semantic Conventions

**Status**: [Experimental](../../document-status.md)
**Status**: [Mixed](../../document-status.md)

<!-- toc -->

Expand Down Expand Up @@ -173,10 +173,10 @@ instrument creation, but can be added if there is ambiguity.

### Instrument Units

**Status**: [Stable](../../document-status.md)
jack-berg marked this conversation as resolved.
Show resolved Hide resolved

Units should follow the
[Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) (need
more clarification in
[#705](https://github.com/open-telemetry/opentelemetry-specification/issues/705)).
[Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html).
trask marked this conversation as resolved.
Show resolved Hide resolved

- Instruments for **utilization** metrics (that measure the fraction out of a
total) are dimensionless and SHOULD use the default unit `1` (the unity).
Expand All @@ -195,6 +195,8 @@ use `{packet}`, `{error}`, `{fault}`, etc.

### Instrument Types

**Status**: [Stable](../../document-status.md)

The semantic metric conventions specification is written to use the names of the synchronous instrument types,
like `Counter` or `UpDownCounter`. However, compliant implementations MAY use the asynchronous equivalent instead,
like `Asynchronous Counter` or `Asynchronous UpDownCounter`.
Expand Down