Add docs and example for OTel JVM runtime metrics#1861
Merged
zeitlinger merged 12 commits intomainprometheus/client_java:mainfrom Feb 12, 2026
Merged
Add docs and example for OTel JVM runtime metrics#1861zeitlinger merged 12 commits intomainprometheus/client_java:mainfrom
zeitlinger merged 12 commits intomainprometheus/client_java:mainfrom
Conversation
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
zeitlinger
commented
Feb 9, 2026
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| - uses: jdx/mise-action@6d1e696aa24c1aa1bcc1adea0212707c71ab78a8 # v3.6.1 | ||
|
|
||
| - name: Remap main branch URLs to PR branch for link checking |
Member
Author
There was a problem hiding this comment.
not related to this PR, but a good opportunity to fix - last time I merged with this check failing and I didn't like it
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation and a runnable example showing how to expose OpenTelemetry JVM runtime metrics (runtime-telemetry) alongside Prometheus Java client metrics on a single /metrics endpoint, including configuration notes and name-mapping guidance.
Changes:
- Adds a new runnable Maven example module demonstrating combined Prometheus + OTel JVM runtime metrics on one endpoint.
- Adds a new docs page describing standalone vs combined setup, configuration toggles, Java 17 JFR notes, and OTel→Prometheus metric name mapping.
- Adjusts link-lint workflow behavior to handle links pointing at
mainfor newly added files.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/pom.xml | Adds the new example module to the examples reactor build. |
| examples/example-otel-jvm-runtime-metrics/src/main/java/io/prometheus/metrics/examples/otelruntimemetrics/Main.java | Demonstrates wiring PrometheusMetricReader into a shared PrometheusRegistry and serving via HTTPServer. |
| examples/example-otel-jvm-runtime-metrics/pom.xml | Adds OTel SDK/exporter/runtime-telemetry dependencies and shaded runnable jar packaging. |
| examples/example-otel-jvm-runtime-metrics/README.md | Provides build/run instructions and expected /metrics output excerpts. |
| docs/content/otel/jvm-runtime-metrics.md | New documentation page describing OTel runtime metrics usage patterns and options. |
| docs/content/instrumentation/jvm.md | Adds a note linking to the new OTel runtime metrics alternative docs. |
| .github/workflows/lint-rest.yml | Updates permissions and adds PR-branch URL remapping for link checking. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jaydeluca
approved these changes
Feb 10, 2026
Collaborator
jaydeluca
left a comment
There was a problem hiding this comment.
couple small nitpicks but lgtm
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.
Alternative for #1854
Summary
Test plan