Visitar URL original
fix: restore legacy suffix compatibility by zeitlinger · Pull Request #2100 · prometheus/client_java · GitHub
Skip to content

fix: restore legacy suffix compatibility - #2100

Merged
zeitlinger merged 2 commits into
prometheus:mainfrom
zeitlinger:fix/legacy-gauge-family-name
May 13, 2026
Merged

fix: restore legacy suffix compatibility#2100
zeitlinger merged 2 commits into
prometheus:mainfrom
zeitlinger:fix/legacy-gauge-family-name

Conversation

@zeitlinger

@zeitlinger zeitlinger commented May 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

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 .created and
.total.

Examples:

  • Gauge("test3.created") regressed from test3 to test3_created
  • Gauge("test6.total") regressed from test6 to test6_total

This 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

  • Fix OM1 text exposition for dotted gauge names ending in .created and
    .total
  • Fix protobuf exposition for the same compatibility cases
  • Add regression tests that cover the restored OM1/protobuf behavior and the
    preserved OpenMetrics behavior
  • Clean up protobuf family-name resolution so legacy gauge handling lives in
    one path instead of pre-rewriting metadata objects

Follow-up stacked PR

Related

Testing

  • mise run build
  • mise run lint
  • ./mvnw test -pl prometheus-metrics-exposition-textformats,prometheus-metrics-exposition-formats -Dtest=ExpositionFormatsTest,ProtobufExpositionFormatsTest,DuplicateNamesProtobufTest -Dcoverage.skip=true -Dcheckstyle.skip=true

This was referenced May 5, 2026
Closed
Closed
Closed
@zeitlinger
fix: restore legacy suffix compatibility
74917b8 
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@jaydeluca
jaydeluca requested a review from Copilot May 7, 2026 23:47
Copilot AI reviewed May 7, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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") and Gauge("*.total").
  • Update PrometheusTextFormatWriter to normalize legacy dotted gauge suffixes when emitting metric names.
  • Update PrometheusProtobufWriterImpl metric-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.

Comment thread ...ormats/src/main/java/io/prometheus/metrics/expositionformats/PrometheusTextFormatWriter.java Resolved
Comment thread ...main/java/io/prometheus/metrics/expositionformats/internal/PrometheusProtobufWriterImpl.java Resolved
@zeitlinger zeitlinger mentioned this pull request May 8, 2026
Merged
@zeitlinger
zeitlinger force-pushed the fix/legacy-gauge-family-name branch from 0eea3c1 to 74917b8 Compare May 8, 2026 07:36
@zeitlinger
fix: normalize legacy gauge names from raw metadata
b5b3def 
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
jaydeluca
jaydeluca reviewed May 12, 2026
View reviewed changes
Comment thread ...theus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/SnapshotEscaper.java Resolved
@zeitlinger
zeitlinger merged commit b2ae70f into prometheus:main May 13, 2026
14 checks passed
@github-actions github-actions Bot mentioned this pull request May 12, 2026
Merged
@zeitlinger zeitlinger mentioned this pull request May 18, 2026
Merged
zeitlinger added a commit that referenced this pull request May 22, 2026
@zeitlinger @jaydeluca
test: validate Micrometer vanilla compatibility (#2121)
db9999a 
Draft validation PR for the unmodified Micrometer compatibility story.

This intentionally does **not** depend on #2114. Vanilla Micrometer does
not use
the typed descriptor API and does not implement the #1800 registration
metadata
hooks, so this PR validates the patch-compatible path independently of
typed
descriptors.

This validates upstream `micrometer-metrics/micrometer@main` against:

- current `main`, which already includes #2100 and #2124 (reserved
suffix
  stripping in `PrometheusNaming.sanitizeMetricName()`).
- Micrometer compatibility test tooling/workflow from
zeitlinger#1.

Local validation:

- `mise run lint`
- `MICROMETER_DIR=/tmp/micrometer-compat-vanilla-2124 mise run
micrometer:test`

---------

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Co-authored-by: Jay DeLuca <jaydeluca4@gmail.com>
zeitlinger added a commit that referenced this pull request Jun 3, 2026
@github-actions @zeitlinger
chore(main): release 1.7.0 (#2092)
574fb73 
🤖 I have created a release *beep* *boop*
---


##
[1.7.0](v1.6.1...v1.7.0)
(2026-06-03)


### Features

* Add StableApi marker and API diff check
([#2168](#2168))
([768fd3a](768fd3a))
* add typed metric family descriptors
([#2114](#2114))
([9c3b097](9c3b097))
* track api-diff baseline via Renovate and store diffs in docs/apidiffs
([#2174](#2174))
([3adb890](3adb890))


### Bug Fixes

* **deps:** update dependency com.github.ben-manes.caffeine:caffeine to
v3.2.4 ([#2088](#2088))
([144eb61](144eb61))
* **deps:** update dependency io.dropwizard.metrics:metrics-core to
v4.2.39 ([#2139](#2139))
([5817d13](5817d13))
* **deps:** update dependency io.dropwizard.metrics5:metrics-core to
v5.0.7 ([#2140](#2140))
([261c451](261c451))
* **deps:** update dependency
io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
to v2.28.0-alpha
([#2126](#2126))
([b62b5d0](b62b5d0))
* **deps:** update dependency
io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
to v2.28.0-alpha
([#2127](#2127))
([e11ce3d](e11ce3d))
* **deps:** update dependency
io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
to v2.28.1-alpha
([#2132](#2132))
([b09be38](b09be38))
* **deps:** update dependency
io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
to v2.28.1-alpha
([#2133](#2133))
([a241c16](a241c16))
* **deps:** update dependency org.apache.tomcat.embed:tomcat-embed-core
to v11.0.22
([#2099](#2099))
([22125c5](22125c5))
* **deps:** update jetty monorepo to v12.1.10
([#2169](#2169))
([ddd3991](ddd3991))
* **deps:** update jetty monorepo to v12.1.9
([#2102](#2102))
([04bee70](04bee70))
* **deps:** update protobuf
([#2129](#2129))
([320538a](320538a))
* Reduce allocations for classic histogram buckets
([#2081](#2081))
([edd160a](edd160a))
* restore legacy suffix compatibility
([#2100](#2100))
([b2ae70f](b2ae70f))
* restore reserved suffix stripping in
`PrometheusNaming.sanitizeMetricName()`
([#2124](#2124))
([2d0f508](2d0f508))


### Performance Improvements

* Refactored sorting to use optimized sort algorithms
([#2161](#2161))
([25b94fc](25b94fc))


### Documentation

* clarify downstream adapter validation requirements
([#2101](#2101))
([ef8c75c](ef8c75c))
* Document OM2
([#2059](#2059))
([45d753c](45d753c))
* document PushGateway shading workaround
([#2106](#2106))
([8ca0eb8](8ca0eb8))

---
> [!IMPORTANT]
> Close and reopen this PR to trigger CI checks.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
jaydeluca pushed a commit that referenced this pull request Jun 4, 2026
@zeitlinger @jaydeluca
fix: restore legacy suffix compatibility (#2100)
b5b86ff 
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 `.created`
and
`.total`.

Examples:

- `Gauge("test3.created")` regressed from `test3` to `test3_created`
- `Gauge("test6.total")` regressed from `test6` to `test6_total`

This 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

- Fix OM1 text exposition for dotted gauge names ending in `.created`
and
  `.total`
- Fix protobuf exposition for the same compatibility cases
- Add regression tests that cover the restored OM1/protobuf behavior and
the
  preserved OpenMetrics behavior
- Clean up protobuf family-name resolution so legacy gauge handling
lives in
  one path instead of pre-rewriting metadata objects

## Follow-up stacked PR

- Micrometer workflow/task split:
zeitlinger#1

## Related

- Replaces: #2093
- Issue: #2095

## Testing

- `mise run build`
- `mise run lint`
- `./mvnw test -pl
prometheus-metrics-exposition-textformats,prometheus-metrics-exposition-formats
-Dtest=ExpositionFormatsTest,ProtobufExpositionFormatsTest,DuplicateNamesProtobufTest
-Dcoverage.skip=true -Dcheckstyle.skip=true`

Signed-off-by: Jay DeLuca <jaydeluca4@gmail.com>
jaydeluca added a commit that referenced this pull request Jun 4, 2026
@zeitlinger @jaydeluca
test: validate Micrometer vanilla compatibility (#2121)
23d7529 
Draft validation PR for the unmodified Micrometer compatibility story.

This intentionally does **not** depend on #2114. Vanilla Micrometer does
not use
the typed descriptor API and does not implement the #1800 registration
metadata
hooks, so this PR validates the patch-compatible path independently of
typed
descriptors.

This validates upstream `micrometer-metrics/micrometer@main` against:

- current `main`, which already includes #2100 and #2124 (reserved
suffix
  stripping in `PrometheusNaming.sanitizeMetricName()`).
- Micrometer compatibility test tooling/workflow from
zeitlinger#1.

Local validation:

- `mise run lint`
- `MICROMETER_DIR=/tmp/micrometer-compat-vanilla-2124 mise run
micrometer:test`

---------

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Co-authored-by: Jay DeLuca <jaydeluca4@gmail.com>
Signed-off-by: Jay DeLuca <jaydeluca4@gmail.com>
jaydeluca pushed a commit that referenced this pull request Jun 4, 2026
@github-actions @zeitlinger @jaydeluca
chore(main): release 1.7.0 (#2092)
d51e654 
🤖 I have created a release *beep* *boop*
---

##
[1.7.0](v1.6.1...v1.7.0)
(2026-06-03)

### Features

* Add StableApi marker and API diff check
([#2168](#2168))
([768fd3a](768fd3a))
* add typed metric family descriptors
([#2114](#2114))
([9c3b097](9c3b097))
* track api-diff baseline via Renovate and store diffs in docs/apidiffs
([#2174](#2174))
([3adb890](3adb890))

### Bug Fixes

* **deps:** update dependency com.github.ben-manes.caffeine:caffeine to
v3.2.4 ([#2088](#2088))
([144eb61](144eb61))
* **deps:** update dependency io.dropwizard.metrics:metrics-core to
v4.2.39 ([#2139](#2139))
([5817d13](5817d13))
* **deps:** update dependency io.dropwizard.metrics5:metrics-core to
v5.0.7 ([#2140](#2140))
([261c451](261c451))
* **deps:** update dependency
io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
to v2.28.0-alpha
([#2126](#2126))
([b62b5d0](b62b5d0))
* **deps:** update dependency
io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
to v2.28.0-alpha
([#2127](#2127))
([e11ce3d](e11ce3d))
* **deps:** update dependency
io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
to v2.28.1-alpha
([#2132](#2132))
([b09be38](b09be38))
* **deps:** update dependency
io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
to v2.28.1-alpha
([#2133](#2133))
([a241c16](a241c16))
* **deps:** update dependency org.apache.tomcat.embed:tomcat-embed-core
to v11.0.22
([#2099](#2099))
([22125c5](22125c5))
* **deps:** update jetty monorepo to v12.1.10
([#2169](#2169))
([ddd3991](ddd3991))
* **deps:** update jetty monorepo to v12.1.9
([#2102](#2102))
([04bee70](04bee70))
* **deps:** update protobuf
([#2129](#2129))
([320538a](320538a))
* Reduce allocations for classic histogram buckets
([#2081](#2081))
([edd160a](edd160a))
* restore legacy suffix compatibility
([#2100](#2100))
([b2ae70f](b2ae70f))
* restore reserved suffix stripping in
`PrometheusNaming.sanitizeMetricName()`
([#2124](#2124))
([2d0f508](2d0f508))

### Performance Improvements

* Refactored sorting to use optimized sort algorithms
([#2161](#2161))
([25b94fc](25b94fc))

### Documentation

* clarify downstream adapter validation requirements
([#2101](#2101))
([ef8c75c](ef8c75c))
* Document OM2
([#2059](#2059))
([45d753c](45d753c))
* document PushGateway shading workaround
([#2106](#2106))
([8ca0eb8](8ca0eb8))

---
> [!IMPORTANT]
> Close and reopen this PR to trigger CI checks.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Jay DeLuca <jaydeluca4@gmail.com>
@josephlbarnett josephlbarnett mentioned this pull request Jun 11, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@jaydeluca jaydeluca jaydeluca approved these changes
@fstab fstab Awaiting requested review from fstab fstab is a code owner
@dhoard dhoard Awaiting requested review from dhoard dhoard is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

bug: restore OM1/protobuf suffix compatibility after #1955

3 participants

@zeitlinger @jaydeluca