-
Notifications
You must be signed in to change notification settings - Fork 893
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
Prometheus spec: Clarify naming of target_info #3700
Comments
What is being proposed or the desired behaviour? It feels that Using a metric type that is not included in the list of types prometheus documents creates friction. |
We should use the types which are appropriate for the protocol. For OpenMetrics, we should follow the OpenMetrics specification, which currently requires the use of an info-typed metric named I am proposing clarifying the language in the specification, not changing it. |
…fo metric naming (#3871) 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. --------- 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]>
…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]>
What are you trying to achieve?
The current specification for converting between prometheus' target info metric and otel resource mixes up target_info (gauge) and target (info), and always refers to the metric as "target_info" without properly distinguishing between the OM and Prom versions:
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/compatibility/prometheus_and_openmetrics.md#resource-attributes-1
The reason for the confusion is that the metric differs between OpenMetrics and Prometheus.
OpenMetrics
Source in OpenMetrics specification:
https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#supporting-target-metadata-in-both-push-based-and-pull-based-systems
Prometheus
In promethues, the metric name always matches the series name for gauges (comments like TYPE and HELP match the metric name). "Info" metrics are a naming convention, rather than a separate type, where the metric has an "_info" suffix and a constant value of 1.
@open-telemetry/wg-prometheus
The text was updated successfully, but these errors were encountered: