naming: Update metric and label name restrictions and recommendations with the latest context#2626
Conversation
…context. ### Notable changes * Cleaned up should/must/may to upper case for clarity (as per RFC style we do in specs). * Mentioned UTF-8 support. * Lifted limited character set from MUST to SHOULD with a clear about consequences and downsides. * Mentioned alternative notations. * Removed experimental mentions about native histograms, made it part of the main sample definition. * Added section on WHY Prometheus metric SHOULD contain type and unit suffix, even with our type and unit labels one day. ### Motivation * [OpenMetrics WG 2.0 Action item](https://docs.google.com/document/d/1FCD-38Xz1-9b3ExgHOeDTQUKUatzgj5KbCND9t-abZY/edit?tab=t.lvx6fags1fga#heading=h.3xjg8jcpctk4 ) and blocker to relax MUST to SHOULD type and unit suffix in OpenMetrics 2.0. * Similarly, to have something clear to reference to highlight huge downsides of skipping suffixes for OTLP (prometheus/prometheus#16441) * To help with explaining this problem to Prometheus users in general (on recent KubeCons we had to explain this hundrends of times). Signed-off-by: bwplotka <bwplotka@gmail.com>
bboreham
reviewed
Apr 17, 2025
Member
bboreham
left a comment
There was a problem hiding this comment.
Generally fine. Some thoughts below.
krajorama
reviewed
Apr 17, 2025
ArthurSens
reviewed
Apr 17, 2025
Member
ArthurSens
left a comment
There was a problem hiding this comment.
besides all that has already been said, found one other thing
Co-authored-by: Bryan Boreham <bjboreham@gmail.com> Co-authored-by: Björn Rabenstein <beorn@grafana.com> Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com> Signed-off-by: Bartlomiej Plotka <bwplotka@gmail.com>
Signed-off-by: bwplotka <bwplotka@gmail.com>
Member
Author
|
Thank you so much for all the great feedback @bboreham @beorn7 @ArthurSens @krajorama Should be good for "final" look! 💪🏽 |
beorn7
approved these changes
Apr 23, 2025
bboreham
approved these changes
Apr 24, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Notable changes
Motivation