Unify runtime-telemetry modules #16087
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,19 @@ | ||
| # Settings for the Runtime Telemetry instrumentation | ||
|
|
||
| | System property | Type | Default | Description | | ||
| | ------------------------------------------------------------------------------------- | ------- | ------- | --------------------------------------------------------------------------------------- | | ||
| | `otel.instrumentation.runtime-telemetry.emit-experimental-metrics` | Boolean | `false` | Enable the capture of experimental metrics. | | ||
| | `otel.instrumentation.runtime-telemetry.experimental.prefer-jfr` | Boolean | `false` | Prefer JFR over JMX for metrics where both collection methods are available (Java 17+). | | ||
| | `otel.instrumentation.runtime-telemetry.experimental.package-emitter.enabled` | Boolean | `false` | Enable creating events for JAR libraries used by the application. | | ||
| | `otel.instrumentation.runtime-telemetry.experimental.package-emitter.jars-per-second` | Integer | 10 | The number of JAR files processed per second. | | ||
|
|
||
| ## Deprecated Properties (to be removed in 3.0) | ||
|
|
||
| | System property | Type | Default | Description | | ||
| | ------------------------------------------------------------------------ | ------- | ------- | --------------------------------------------------------------------------------- | | ||
| | `otel.instrumentation.runtime-telemetry.capture-gc-cause` | Boolean | `false` | Enable the capture of the jvm.gc.cause attribute. Will always be captured in 3.0. | | ||
| | `otel.instrumentation.runtime-telemetry.emit-experimental-telemetry` | Boolean | `false` | Use `emit-experimental-metrics` instead. | | ||
| | `otel.instrumentation.runtime-telemetry.package-emitter.enabled` | Boolean | `false` | Use `experimental.package-emitter.enabled` instead. | | ||
| | `otel.instrumentation.runtime-telemetry.package-emitter.jars-per-second` | Integer | 10 | Use `experimental.package-emitter.jars-per-second` instead. | | ||
| | `otel.instrumentation.runtime-telemetry-java17.enabled` | Boolean | `false` | Deprecated. Use `emit-experimental-metrics` for experimental JFR features. | | ||
| | `otel.instrumentation.runtime-telemetry-java17.enable-all` | Boolean | `false` | Deprecated. Use `emit-experimental-metrics` and `experimental.prefer-jfr`. | |
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,16 @@ | ||
| plugins { | ||
| id("otel.javaagent-instrumentation") | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation(project(":instrumentation:runtime-telemetry:library")) | ||
|
|
||
| compileOnly("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure") | ||
| compileOnly("io.opentelemetry:opentelemetry-api-incubator") | ||
| } | ||
|
|
||
| tasks { | ||
| test { | ||
| jvmArgs("-Dotel.instrumentation.runtime-telemetry.experimental.package-emitter.enabled=true") | ||
| } | ||
| } |
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,83 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.runtimetelemetry; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import io.opentelemetry.api.GlobalOpenTelemetry; | ||
| import io.opentelemetry.api.OpenTelemetry; | ||
| import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties; | ||
| import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil; | ||
| import io.opentelemetry.javaagent.bootstrap.InstrumentationHolder; | ||
| import io.opentelemetry.javaagent.tooling.BeforeAgentListener; | ||
| import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk; | ||
| import java.lang.instrument.Instrumentation; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** Installs the {@link JarAnalyzer}. */ | ||
| @AutoService(BeforeAgentListener.class) | ||
| public class JarAnalyzerInstaller implements BeforeAgentListener { | ||
|
|
||
| private static final Logger logger = Logger.getLogger(JarAnalyzerInstaller.class.getName()); | ||
| private static final int DEFAULT_JARS_PER_SECOND = 10; | ||
|
|
||
| @Override | ||
| public void beforeAgent(AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) { | ||
| OpenTelemetry openTelemetry = GlobalOpenTelemetry.get(); | ||
| DeclarativeConfigProperties config = | ||
|
Member
There was a problem hiding this comment. do I get it right that we're no longer checking if a module is active?
Member
Author
There was a problem hiding this comment. it's still being checked, a few lines down |
||
| DeclarativeConfigUtil.getInstrumentationConfig(openTelemetry, "runtime_telemetry"); | ||
|
|
||
| // Support both new config (package_emitter/development) and old path | ||
| // (package_emitter) | ||
| DeclarativeConfigProperties newPackageEmitterConfig = config.get("package_emitter/development"); | ||
| DeclarativeConfigProperties oldPackageEmitterConfig = config.get("package_emitter"); | ||
|
|
||
| boolean enabledNew = newPackageEmitterConfig.getBoolean("enabled", false); | ||
| boolean enabledOld = oldPackageEmitterConfig.getBoolean("enabled", false); | ||
| if (enabledOld) { | ||
| logger.warning( | ||
| "otel.instrumentation.runtime-telemetry.package-emitter.enabled is deprecated and will" | ||
| + " be removed in 3.0. Use" | ||
| + " otel.instrumentation.runtime-telemetry.experimental.package-emitter.enabled" | ||
| + " instead."); | ||
| } | ||
| if (!enabledNew && !enabledOld) { | ||
| return; | ||
| } | ||
| Instrumentation inst = InstrumentationHolder.getInstrumentation(); | ||
| if (inst == null) { | ||
| return; | ||
| } | ||
|
|
||
| // Use appropriate instrumentation name based on which config is active | ||
| String instrumentationName = | ||
| enabledNew | ||
| ? "io.opentelemetry.runtime-telemetry" | ||
| : "io.opentelemetry.runtime-telemetry-java8"; | ||
|
|
||
| int newJarsPerSecond = newPackageEmitterConfig.getInt("jars_per_second", -1); | ||
| int oldJarsPerSecond = oldPackageEmitterConfig.getInt("jars_per_second", -1); | ||
|
|
||
| if (oldJarsPerSecond >= 0) { | ||
| logger.warning( | ||
| "otel.instrumentation.runtime-telemetry.package-emitter.jars-per-second is deprecated" | ||
| + " and will be removed in 3.0. Use" | ||
| + " otel.instrumentation.runtime-telemetry.experimental.package-emitter.jars-per-second" | ||
| + " instead."); | ||
| } | ||
|
|
||
| int jarsPerSecond; | ||
| if (newJarsPerSecond >= 0) { | ||
| jarsPerSecond = newJarsPerSecond; | ||
| } else if (oldJarsPerSecond >= 0) { | ||
| jarsPerSecond = oldJarsPerSecond; | ||
| } else { | ||
| jarsPerSecond = DEFAULT_JARS_PER_SECOND; | ||
| } | ||
|
|
||
| JarAnalyzer jarAnalyzer = JarAnalyzer.create(openTelemetry, instrumentationName, jarsPerSecond); | ||
| inst.addTransformer(jarAnalyzer); | ||
| } | ||
| } | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
this rule conflicted with spotless handling of empty default expression in Java 17 switch statement
we could probably get rid of a lot of checkstyle checks that are already covered by spotless