docs(opentelemtry): Add explanation of UnderscoreEscapingWithoutSuffixes translation strategy #2688
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
ywwg
added a commit
to prometheus/prometheus
that referenced
this pull request
Jul 9, 2025
The last permutation of the translation options does underscore translation but does not add suffixes. This translation option already exists in Mimir as otel_metric_suffixes_enabled, indicating external demand for this strategy. There is an accompanying update to prometheus-docs to explain the use of this mode: prometheus/docs#2688
ywwg
added a commit
to prometheus/prometheus
that referenced
this pull request
Jul 9, 2025
The last permutation of the translation options does underscore translation but does not add suffixes. This translation option already exists in Mimir as otel_metric_suffixes_enabled, indicating external demand for this strategy. There is an accompanying update to prometheus-docs to explain the use of this mode: prometheus/docs#2688 Signed-off-by: Owen Williams <owen.williams@grafana.com>
…xes translation strategy Signed-off-by: Owen Williams <owen.williams@grafana.com>
25ea099 to
575d08c
Compare
ArthurSens
reviewed
Jul 9, 2025
docs/guides/opentelemetry.md
Outdated
Comment on lines
155
to
156
| * `NoTranslation`. This strategy bypasses all metric and label name translation, passing them through unaltered. This mode requires UTF-8 to be enabled. Note that without suffixes, it is possible to have collisions when multiple metrics of the same name have different type or units. | ||
| * `UnderscoreEscapingWithoutSuffixes`. This fully escapes metric names similar to UnderscoreEscapingWithSuffixes, but does not append type and unit suffixes. This mode is undesirable from a number of standpoints and users should be aware that the lack of suffixes could cause metric name collisions and only enable this mode in concert with careful testing. It is used by some organizations who prefer this balance of Otel symmetry and limited character support. |
There was a problem hiding this comment.
Could "NoTranslation" be the last one? I can't explain why, but that order feels weird 😛
There was a problem hiding this comment.
Yeah I can keep the order the same as it has appeared elsewhere
ywwg
added a commit
to prometheus/prometheus
that referenced
this pull request
Jul 10, 2025
…16849) The last permutation of the translation options does underscore translation but does not add suffixes. This translation option already exists in Mimir as otel_metric_suffixes_enabled, indicating external demand for this strategy. There is an accompanying update to prometheus-docs to explain the use of this mode: prometheus/docs#2688 Signed-off-by: Owen Williams <owen.williams@grafana.com>
ArthurSens
approved these changes
Jul 10, 2025
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.
ref: prometheus/prometheus#16849