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.

Sign up for GitHub

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

Jump to bottom

Clarify that unit must be a suffix for metric names for Prometheus #4057

Merged
merged 3 commits into from
May 24, 2024
Merged

Clarify that unit must be a suffix for metric names for Prometheus #4057

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3dfb383
clarify that unit must be a suffix for metric names
dashpole May 23, 2024
3786e62
clarify that the unit metadata must be omitted if the unit suffix is …
dashpole May 24, 2024
d86989d
Merge branch 'main' into clarify_unit_location
reyang May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ release.

### Compatibility

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

### SDK Configuration

### Common
Expand Down
6 changes: 3 additions & 3 deletions specification/compatibility/prometheus_and_openmetrics.md
View file
Open in desktop
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
dashpole marked this conversation as resolved.
Show resolved Hide resolved
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
Loading