Skip to content

Commit

Permalink
Clarify differences between prometheus protocols, including target in…
Browse files Browse the repository at this point in the history
…fo metric naming (open-telemetry#3871)

Fixes
open-telemetry#3700

## Changes

The current specification mixes OpenMetrics and Prometheus in ways that
can be confusing. This change first explains the differences between
various Prometheus formats, and then consistently uses "Prometheus" to
refer to the general conversion rules. This is helpful for explaining
why the target (info) metric naming differs depending on the format
used.

Also, fix references to the "target" info-typed metric, which was
previously referred to as "target_info". "target_info" is only used when
info-typed metrics are not supported.

---------

Co-authored-by: Yuri Shkuro <[email protected]>
Co-authored-by: Eero Tamminen <[email protected]>
Co-authored-by: Robert Pająk <[email protected]>
Co-authored-by: Anthony Mirabella <[email protected]>
Co-authored-by: Josh Suereth <[email protected]>
  • Loading branch information
6 people authored Mar 14, 2024
1 parent b8bada5 commit 623579c
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 44 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 compatibility: Clarify naming of the target info metric, and differences between various Prometheus formats.
([#3871](https://github.com/open-telemetry/opentelemetry-specification/pull/3871))

### SDK Configuration

### Common
Expand Down
Loading

0 comments on commit 623579c

Please sign in to comment.