jmx idiomatic library API - part 1 #15220
+271
−118
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.jmx; | ||
|
|
||
| import com.google.errorprone.annotations.CanIgnoreReturnValue; | ||
| import io.opentelemetry.api.OpenTelemetry; | ||
| import io.opentelemetry.instrumentation.jmx.engine.JmxMetricInsight; | ||
| import io.opentelemetry.instrumentation.jmx.engine.MetricConfiguration; | ||
| import java.util.List; | ||
| import java.util.function.Supplier; | ||
| import javax.management.MBeanServerConnection; | ||
| import javax.management.MBeanServerFactory; | ||
|
|
||
| /** Entrypoint for JMX metrics Insights */ | ||
| public final class JmxTelemetry { | ||
|
|
||
| private final JmxMetricInsight service; | ||
| private final MetricConfiguration metricConfiguration; | ||
|
|
||
| /** Returns a new {@link JmxTelemetryBuilder} configured with the given {@link OpenTelemetry}. */ | ||
| public static JmxTelemetryBuilder builder(OpenTelemetry openTelemetry) { | ||
| return new JmxTelemetryBuilder(openTelemetry); | ||
| } | ||
|
|
||
| JmxTelemetry( | ||
| OpenTelemetry openTelemetry, long discoveryDelayMs, MetricConfiguration metricConfiguration) { | ||
| this.service = JmxMetricInsight.createService(openTelemetry, discoveryDelayMs); | ||
| this.metricConfiguration = metricConfiguration; | ||
| } | ||
|
|
||
| /** | ||
| * Starts JMX metrics collection on current JVM | ||
| * | ||
| * @return this | ||
| */ | ||
| @CanIgnoreReturnValue | ||
| public JmxTelemetry start() { | ||
| return this.start(() -> MBeanServerFactory.findMBeanServer(null)); | ||
| } | ||
|
|
||
| /** | ||
| * Starts JMX metrics collection on provided (local or remote) connections | ||
| * | ||
| * @param connections connection provider | ||
| * @return this | ||
| */ | ||
| @CanIgnoreReturnValue | ||
| public JmxTelemetry start(Supplier<List<? extends MBeanServerConnection>> connections) { | ||
| service.start(metricConfiguration, connections); | ||
| return this; | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.jmx; | ||
|
|
||
| import static java.util.logging.Level.FINE; | ||
|
|
||
| import com.google.errorprone.annotations.CanIgnoreReturnValue; | ||
| import io.opentelemetry.api.OpenTelemetry; | ||
| import io.opentelemetry.instrumentation.jmx.engine.MetricConfiguration; | ||
| import io.opentelemetry.instrumentation.jmx.yaml.RuleParser; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.time.Duration; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** Builder for {@link JmxTelemetry} */ | ||
| public final class JmxTelemetryBuilder { | ||
|
|
||
| private static final Logger logger = Logger.getLogger(JmxTelemetryBuilder.class.getName()); | ||
|
|
||
| private final OpenTelemetry openTelemetry; | ||
| private final MetricConfiguration metricConfiguration; | ||
| private long discoveryDelayMs; | ||
|
|
||
| JmxTelemetryBuilder(OpenTelemetry openTelemetry) { | ||
| this.openTelemetry = openTelemetry; | ||
| this.discoveryDelayMs = 0; | ||
| this.metricConfiguration = new MetricConfiguration(); | ||
| } | ||
|
|
||
| /** | ||
| * Sets initial delay for MBean discovery | ||
| * | ||
| * @param delay delay | ||
| * @return builder instance | ||
| */ | ||
| @CanIgnoreReturnValue | ||
| public JmxTelemetryBuilder beanDiscoveryDelay(Duration delay) { | ||
| if (delay.isNegative()) { | ||
| throw new IllegalArgumentException("delay must be positive or zero"); | ||
| } | ||
| this.discoveryDelayMs = delay.toMillis(); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds built-in JMX rules from classpath resource | ||
| * | ||
| * @param target name of target in /jmx/rules/{target}.yaml classpath resource | ||
| * @return builder instance | ||
| * @throws IllegalArgumentException when classpath resource does not exist or can't be parsed | ||
| */ | ||
| @CanIgnoreReturnValue | ||
| public JmxTelemetryBuilder addClassPathRules(String target) { | ||
| String yamlResource = String.format("jmx/rules/%s.yaml", target); | ||
| try (InputStream inputStream = | ||
| JmxTelemetryBuilder.class.getClassLoader().getResourceAsStream(yamlResource)) { | ||
| if (inputStream == null) { | ||
| throw new IllegalArgumentException("JMX rules not found in classpath: " + yamlResource); | ||
| } | ||
| logger.log(FINE, "Adding JMX config from classpath for {0}", yamlResource); | ||
| RuleParser parserInstance = RuleParser.get(); | ||
| parserInstance.addMetricDefsTo(metricConfiguration, inputStream, target); | ||
| } catch (Exception e) { | ||
| throw new IllegalArgumentException( | ||
| "Unable to load JMX rules from classpath: " + yamlResource, e); | ||
| } | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds custom JMX rules from file system path | ||
| * | ||
| * @param path path to yaml file | ||
| * @return builder instance | ||
| * @throws IllegalArgumentException when classpath resource does not exist or can't be parsed | ||
| */ | ||
| @CanIgnoreReturnValue | ||
| public JmxTelemetryBuilder addCustomRules(Path path) { | ||
| logger.log(FINE, "Adding JMX config from file: {0}", path); | ||
| RuleParser parserInstance = RuleParser.get(); | ||
| try (InputStream inputStream = Files.newInputStream(path)) { | ||
| parserInstance.addMetricDefsTo(metricConfiguration, inputStream, path.toString()); | ||
| } catch (IOException e) { | ||
| throw new IllegalArgumentException("Unable to load JMX rules in path: " + path, e); | ||
| } | ||
| return this; | ||
| } | ||
|
|
||
| public JmxTelemetry build() { | ||
| return new JmxTelemetry(openTelemetry, discoveryDelayMs, metricConfiguration); | ||
| } | ||
| } |
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
Oops, something went wrong.
Oops, something went wrong.
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 a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[for reviewer] this part is now embedded directly into the library, so we don't expose internal details anymore, this also enables removing similar code in contrib jmx-scraper (or anything that does rely on this library).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we have a plan how to use declarative configuration instead of a separate yaml file in the future?
I bring it up because a library redesign would be a good opportunity to plan ahead for that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good point, we don't have any concrete plan for declarative config, but this is something that we need to think about in the future, I have already opened #14916 to not forget about it.