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

Clarify differences between prometheus protocols, including target info metric naming #3871

Merged
merged 11 commits into from
Mar 14, 2024

Conversation

dashpole
Copy link
Contributor

@dashpole dashpole commented Feb 8, 2024

Fixes #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.

@dashpole dashpole requested review from a team February 8, 2024 20:02
@dashpole dashpole force-pushed the clarify_prometheus_protocols branch from f0283d5 to f0d715f Compare February 8, 2024 20:03
@dashpole dashpole changed the title Clarify differences between prometheus protocols and target info metric naming Clarify differences between prometheus protocols, including target info metric naming Feb 8, 2024
@dashpole
Copy link
Contributor Author

dashpole commented Feb 8, 2024

@open-telemetry/wg-prometheus

Copy link
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To confirm:

target metrics would still be called target_info when ingested in prometheus? I.e. this isn't a breaking change, correct?

@dashpole
Copy link
Contributor Author

dashpole commented Feb 9, 2024

target metrics would still be called target_info when ingested in prometheus? I.e. this isn't a breaking change, correct?

Correct. This is keeping the same behavior, and is just trying to make the existing spec easier to read.

The only hesitation I have with the current spec is that if Prometheus text format adds an info type, it would be breaking for us to start using it, since we would change the name from target_info to target.

CHANGELOG.md Outdated Show resolved Hide resolved
specification/compatibility/prometheus_and_openmetrics.md Outdated Show resolved Hide resolved
specification/compatibility/prometheus_and_openmetrics.md Outdated Show resolved Hide resolved
@dashpole dashpole force-pushed the clarify_prometheus_protocols branch from 6608bab to cf3fda7 Compare February 29, 2024 01:30
@jsuereth jsuereth merged commit a5ce0bc into open-telemetry:main Mar 14, 2024
7 checks passed
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
…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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prometheus spec: Clarify naming of target_info
10 participants