Fix escaping#1668
Merged
zeitlinger merged 2 commits intomainprometheus/client_java:mainfrom Nov 7, 2025
Merged
Conversation
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes handling of metric names containing characters that are not valid in legacy Prometheus naming conventions (e.g., colons and dots). The changes ensure that when such names are encountered, they are properly escaped and formatted according to OpenMetrics and Prometheus text format specifications.
Key changes:
- Corrected the validation check in
PrometheusTextFormatWriterfromisValidLegacyLabelNametoisValidLegacyMetricName - Fixed the comma separator logic in
TextFormatUtil.writeLabelsto handle cases where metric names are inside braces - Added test cases for metrics with colons and dots in their names
- Updated existing test expectations to use colons in metric names for validation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| PrometheusTextFormatWriter.java | Fixed bug where metric name validation was incorrectly using label name validation method |
| TextFormatUtil.java | Fixed comma separator logic to account for metric names inside braces when adding additional labels |
| ExpositionFormatsTest.java | Added test case for histogram with dots in name and updated existing counter test to use colons |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...textformats/src/test/java/io/prometheus/metrics/expositionformats/ExpositionFormatsTest.java
Show resolved
Hide resolved
jaydeluca
approved these changes
Nov 7, 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
2 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.
Fixes #1666