Fix OpenMetrics valid label keys, and specify prometheus conversion for metric name. #2788
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dashpole
force-pushed
the
fix_prom_regex
branch
from
03335f1
to
3502920
Compare
MrAlias
approved these changes
Sep 12, 2022
damemi
reviewed
Sep 13, 2022
damemi
approved these changes
Sep 13, 2022
|
cc @open-telemetry/wg-prometheus |
bogdandrutu
approved these changes
Sep 16, 2022
|
@dashpole related question, maybe not answered in this PR: |
|
For Prometheus/OpenMetrics, empty label keys aren't allowed. We should drop + warn for an empty label. For exporters written using prometheus client libraries, that is already done by the client's validation (e.g. prometheus/client_golang). It might be good to include a catchall statement somewhere to the effect of: "exporters should produce valid prometheus/openmetrics metrics, or MUST drop the metric and emit a warning". |
reyang
approved these changes
Sep 16, 2022
jmacd
approved these changes
Sep 16, 2022
carlosalberto
pushed a commit
to carlosalberto/opentelemetry-specification
that referenced
this pull request
Oct 31, 2024
…or metric name. (open-telemetry#2788) * fix OpenMetrics valid label keys, and specify prometheus conversion for metric name. * deduplicate underscores and fix formatting Co-authored-by: Bogdan Drutu <bogdandrutu@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This fixes an incorrect statement about the allowed characters in prometheus label keys found here: open-telemetry/opentelemetry-go#3135 (comment).
During the process, I also realized we don't specify conversion rules for the metric name, including the rules for sanitizing the metric name when converting from OTLP to Prom.
Source: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#abnf
In that spec,
metricname-initial-charallows:, butlabel-name-initial-chardoes not.