Skip to content

Commit

Permalink
clarify that unit must be a suffix for metric names
Browse files Browse the repository at this point in the history
  • Loading branch information
dashpole committed May 23, 2024
1 parent 6b5e940 commit 5071d15
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ release.

### Compatibility

- Prometheus: Clarify location of unit suffix within metric names.
([#TODO](https://github.com/open-telemetry/opentelemetry-specification/pull/TODO))

### SDK Configuration

### Common
Expand Down
6 changes: 3 additions & 3 deletions specification/compatibility/prometheus_and_openmetrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,9 +267,9 @@ The Unit of an OTLP metric point SHOULD be converted to the equivalent unit in P

The resulting unit SHOULD be added to the metric as
[UNIT metadata](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#metricfamily)
and as a suffix to the metric name unless the metric name already contains the
unit, or the unit MUST be omitted. The unit suffix comes before any
type-specific suffixes.
and as a suffix to the metric name unless the metric name already ends with the
unit (before type-specific suffixes), or the unit MUST be omitted. The unit
suffix comes before any type-specific suffixes.

The description of an OTLP metrics point MUST be added as
[HELP metadata](https://prometheus.io/docs/instrumenting/exposition_formats/#comments-help-text-and-type-information).
Expand Down

0 comments on commit 5071d15

Please sign in to comment.