Add stable Metrics class to decouple consumers from protobuf version - #1873
Merged
Conversation
The generated protobuf Metrics.java lives in a versioned package that changes every protobuf release, requiring import updates in all consumer files. Introduce a stable extending class in the version-free package so consumers import from a single stable location. On protobuf upgrades only the extends clause in the stable class changes, handled automatically by generate-protobuf.sh. Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Member
Author
|
approved by @dhoard |
2 tasks
This was referenced Jun 2, 2026
Closed
zeitlinger
added a commit
that referenced
this pull request
Jun 3, 2026
Follow-up to #2167 ([review comment](#2167 (comment))): switches the JMX Exporter compatibility job to the **quick test** configuration and fixes the gaps that surfaced. **Changes** - **Quick test config** (`jmx_exporter_compat.py`): build the full reactor (`clean install`) so `integration_test_suite` actually runs, pinned to a single Java + Prometheus distribution. The pins are read from the checked-out jmx_exporter's `run-quick-test.sh` so they stay aligned with upstream; `-Dparamixel.parallelism` set to CPU count. - **Test `main`, not the release**: the integration suite only compiles against current `client_java` when jmx_exporter imports the stable `expositionformats.generated.Metrics` class (#1873). Release 1.5.0 imports the version-stamped `com_google_protobuf_4_32_0` package directly, which breaks on protobuf bumps (now 4.35.0); `main` uses the stable class. Tracked by #2179 — switch the ref back to a pinned release once one ships the fix. - **Renovate guard** (`renovate.json5`): block major JDK bumps for the jmx-exporter and micrometer compat env files (they pin an LTS JDK the upstream release supports). This supersedes #2173-style bumps. **Local validation**: `mise run lint:fix`; image-pin regex verified against `prometheus/jmx_exporter@main`. Full integration run is validated by CI (needs Docker + JDK 21). --------- Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
jaydeluca
pushed a commit
that referenced
this pull request
Jun 4, 2026
Follow-up to #2167 ([review comment](#2167 (comment))): switches the JMX Exporter compatibility job to the **quick test** configuration and fixes the gaps that surfaced. **Changes** - **Quick test config** (`jmx_exporter_compat.py`): build the full reactor (`clean install`) so `integration_test_suite` actually runs, pinned to a single Java + Prometheus distribution. The pins are read from the checked-out jmx_exporter's `run-quick-test.sh` so they stay aligned with upstream; `-Dparamixel.parallelism` set to CPU count. - **Test `main`, not the release**: the integration suite only compiles against current `client_java` when jmx_exporter imports the stable `expositionformats.generated.Metrics` class (#1873). Release 1.5.0 imports the version-stamped `com_google_protobuf_4_32_0` package directly, which breaks on protobuf bumps (now 4.35.0); `main` uses the stable class. Tracked by #2179 — switch the ref back to a pinned release once one ships the fix. - **Renovate guard** (`renovate.json5`): block major JDK bumps for the jmx-exporter and micrometer compat env files (they pin an LTS JDK the upstream release supports). This supersedes #2173-style bumps. **Local validation**: `mise run lint:fix`; image-pin regex verified against `prometheus/jmx_exporter@main`. Full integration run is validated by CI (needs Docker + JDK 21). --------- Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com> Signed-off-by: Jay DeLuca <jaydeluca4@gmail.com>
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
1 participant
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.
Summary
Metrics.javain the version-free...generatedpackage that extends the versioned generated class, so consumer code no longer needs import updates on protobuf upgrades.generate-protobuf.shto make the generated class extensible (finalremoved, constructorprotected) and read the old package from the stable class'sextendsclause.@SuppressWarnings("NonCanonicalType")for Error Prone compatibility.Test plan
mise run buildpasses (all 54 modules)mise run test -pl prometheus-metrics-exposition-formatspasses (47 tests)mise run lint:super-linterpasses