Update OM1.1 for UTF-8 metric names and labels #2746
Conversation
This file contains hidden or 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
Part of prometheus/prometheus#16093 Signed-off-by: Owen Williams <[email protected]>
ywwg
force-pushed
the
owilliams/utf8-abnf
branch
from
755a40d to
908e3a6
Compare
ywwg
commented
Oct 2, 2025
Signed-off-by: Owen Williams <[email protected]>
Signed-off-by: Owen Williams <[email protected]>
dashpole
approved these changes
Oct 3, 2025
krajorama
requested changes
Oct 6, 2025
krajorama
reviewed
Oct 7, 2025
|
@ywwg I'd suggest to scan the "Design considerations" section, in particular https://prometheus.io/docs/specs/om/open_metrics_spec/#metric-naming-and-namespaces . I've done it as a follow-up to relaxed suffix rules, see #2751 |
Signed-off-by: Owen Williams <[email protected]>
dashpole
reviewed
Oct 10, 2025
| --> | ||
|
|
||
| We aim for a balance between understandability, avoiding clashes, and succinctness in the naming of metrics and label names. Names are separated through underscores, so metric names end up being in “snake_case”. | ||
| We aim for a balance between understandability, avoiding clashes, and succinctness in the naming of metrics and label names. Names are separated through underscores, so metric names end up being in “snake_case”. While we strongly recommend the practices recommended in this document, other metric systems have different philosophies regarding naming conventions. OpenMetrics allows metrics to be exposed, but without the conventions and suffixes recommended here there is an increased risk of collisions and incompatibilities along the chain of services in a metrics system. Users wishing to use alternative conventions will need to take special care and expend additional effort to ensure that the entire ecosystem is consistent. |
There was a problem hiding this comment.
Suggested change
| We aim for a balance between understandability, avoiding clashes, and succinctness in the naming of metrics and label names. Names are separated through underscores, so metric names end up being in “snake_case”. While we strongly recommend the practices recommended in this document, other metric systems have different philosophies regarding naming conventions. OpenMetrics allows metrics to be exposed, but without the conventions and suffixes recommended here there is an increased risk of collisions and incompatibilities along the chain of services in a metrics system. Users wishing to use alternative conventions will need to take special care and expend additional effort to ensure that the entire ecosystem is consistent. | |
| We aim for a balance between understandability, avoiding clashes, and succinctness in the naming of metrics and label names. Names are separated through underscores, so metric names end up being in “snake_case”. While we strongly recommend the practices recommended in this document, other metric systems have different philosophies regarding naming conventions. OpenMetrics allows these metrics to be exposed, but without the conventions and suffixes recommended here there is an increased risk of collisions and incompatibilities along the chain of services in a metrics system. Users wishing to use alternative conventions will need to take special care and expend additional effort to ensure that the entire system is consistent. |
dashpole
approved these changes
Oct 10, 2025
bwplotka
reviewed
Oct 13, 2025
There was a problem hiding this comment.
Looks good to me, thanks for extending!
I assume we will follow with same/similar wording in 2.0, right?
Can we outline e.g. in the description of this PR why we add UTF-8 capability to 1.1 instead of releasing this change with 2.0? Would be useful for bookkeeping.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
part of prometheus/prometheus#16093