fix: restore legacy suffix compatibility#2100
Open
zeitlinger wants to merge 1 commit intoprometheus:mainfrom
Open
fix: restore legacy suffix compatibility#2100zeitlinger wants to merge 1 commit intoprometheus:mainfrom
zeitlinger wants to merge 1 commit intoprometheus:mainfrom
Conversation
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Restores legacy OM1 (Prometheus text 0.0.4) and protobuf exposition behavior for gauge names that end with suffix-like dotted strings (e.g. .created, .total), while keeping OpenMetrics output on literal-name handling to avoid reintroducing prior regressions.
Changes:
- Add regression tests covering OpenMetrics vs OM1/protobuf behavior for
Gauge("*.created")andGauge("*.total"). - Update
PrometheusTextFormatWriterto normalize legacy dotted gauge suffixes when emitting metric names. - Update
PrometheusProtobufWriterImplmetric-family naming to normalize the same legacy gauge cases, and add a protobuf duplicate-names regression test.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/ExpositionFormatsTest.java | Adds cross-format regression coverage for dotted gauge suffix compatibility. |
| prometheus-metrics-exposition-textformats/src/main/java/io/prometheus/metrics/expositionformats/PrometheusTextFormatWriter.java | Implements legacy dotted gauge suffix normalization for Prometheus text exposition. |
| prometheus-metrics-exposition-formats/src/test/java/io/prometheus/metrics/expositionformats/DuplicateNamesProtobufTest.java | Adds protobuf regression test for .total dotted gauge normalization affecting family naming. |
| prometheus-metrics-exposition-formats/src/main/java/io/prometheus/metrics/expositionformats/internal/PrometheusProtobufWriterImpl.java | Centralizes metric-family name resolution and adds legacy dotted gauge normalization for protobuf. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| if (originalName.endsWith(".total")) { | ||
| return PrometheusNaming.escapeName( | ||
| originalName.substring(0, originalName.length() - ".total".length()), scheme); | ||
| } |
| if (originalName.endsWith(".total")) { | ||
| return PrometheusNaming.escapeName( | ||
| originalName.substring(0, originalName.length() - ".total".length()), scheme); | ||
| } |
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
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 #2095
Summary
Restores OM1/protobuf compatibility for dotted gauge names after
feat: move suffix handling to scrape time (#1955).The bug was that non-OpenMetrics exposition changed visible output for gauge
names that merely ended in suffix-like dotted strings such as
.createdand.total.Examples:
Gauge("test3.created")regressed fromtest3totest3_createdGauge("test6.total")regressed fromtest6totest6_totalThis PR restores the legacy OM1/protobuf behavior while keeping OpenMetrics on
literal-name handling.
This is the extracted prom-side fix from #2093. The Micrometer workflow and
related downstream testing were split into a stacked follow-up PR so this can
merge independently.
What changed
.createdand.totalpreserved OpenMetrics behavior
one path instead of pre-rewriting metadata objects
Follow-up stacked PR
Related
Testing
mise run buildmise run lint./mvnw test -pl prometheus-metrics-exposition-textformats,prometheus-metrics-exposition-formats -Dtest=ExpositionFormatsTest,ProtobufExpositionFormatsTest,DuplicateNamesProtobufTest -Dcoverage.skip=true -Dcheckstyle.skip=true