jmx-metrics: allow any resource path for classpath resources rules #15413
Conversation
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
SylvainJuge
commented
Nov 20, 2025
...jmx-metrics/library/src/test/java/io/opentelemetry/instrumentation/jmx/JmxTelemetryTest.java
Outdated
Show resolved
Hide resolved
laurit
reviewed
Nov 21, 2025
...-metrics/library/src/main/java/io/opentelemetry/instrumentation/jmx/JmxTelemetryBuilder.java
Outdated
Show resolved
Hide resolved
…nstrumentation into jmx-api-path
laurit
reviewed
Nov 27, 2025
...-metrics/library/src/main/java/io/opentelemetry/instrumentation/jmx/JmxTelemetryBuilder.java
Outdated
Show resolved
Hide resolved
laurit
reviewed
Nov 27, 2025
| * @return builder instance | ||
| * @throws IllegalArgumentException when classpath resource does not exist or can't be parsed | ||
| */ | ||
| // TODO: deprecate this method after 2.23.0 release in favor of addRules |
Contributor
There was a problem hiding this comment.
why don't you deprecate it immediately?
Contributor
Author
There was a problem hiding this comment.
If we deprecate it right now, it means the next update of instrumentation dependency in contrib will require to immediately modify the code of jmx-scraper in contrib to switch to the new API. Even if the changes are minor it's an added constraint on the dependency update.
Doing that after 2.23.0 gives a bit more time with a timeline like this:
- instrumentation 2.23.0 is released with this new API
- contrib gets updated to use 2.23.0 dependency
- we update
jmx-scraperto use the new API introduced by this PR - we deprecate methods in this API, this will likely be for the 2.24.0 release
…nstrumentation into jmx-api-path
…nstrumentation into jmx-api-path
robsunday
approved these changes
Nov 28, 2025
robsunday
reviewed
Nov 28, 2025
.../src/main/java/io/opentelemetry/instrumentation/javaagent/jmx/JmxMetricInsightInstaller.java
Outdated
Show resolved
Hide resolved
laurit
reviewed
Dec 3, 2025
…nstrumentation into jmx-api-path
laurit
reviewed
Dec 3, 2025
laurit
approved these changes
Dec 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
There was an oversight in #15220, which I unfortunately only discovered when plumbing this new API in jmx-scraper with open-telemetry/opentelemetry-java-contrib#2446.
This PR adds a more versatile
JmxTelemetryBuilder#addRulesas replacement, this allows to load JMX metrics rules from anyInputStream, not only the classpath resources injmx/rules.The following methods are not yet annotated with
@Deprecatedto prevent having to deal with changes when the dependency of contrib to instrumentation is updated, they should be replaced withJmxTelemetryBuilder#addRulesin the future:JmxTelemetryBuilder#addClassPathRulesJmxTelemetryBuilder#addCustomRulesThis limitation currently makes loading "legacy" metrics definitions in jmx-scraper more complicated than necessary (see open-telemetry/opentelemetry-java-contrib#2446 for details).