Enable opentelemetry-api and opentelemetry-instrumentation-annotations even when default-enabled is false#18792
Merged
Conversation
trask
changed the title
trask
force-pushed
the
default-instrumentation
branch
2 times, most recently
from
May 19, 2026 00:13
67233a6 to
9bd7dcb
Compare
trask
force-pushed
the
default-instrumentation
branch
2 times, most recently
from
May 19, 2026 02:55
222ea7d to
051868e
Compare
trask
marked this pull request as ready for review
May 19, 2026 02:56
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a new internal helper, V3PreviewFallbackEnabledInstrumentationModule, that overrides defaultEnabled() to return true when the v3 preview flag (otel.instrumentation.common.v3-preview / declarative instrumentation.common.v3_preview) is enabled, in addition to the normal default-enabled check. The base class is then applied to every javaagent opentelemetry-api-* instrumentation module and to the opentelemetry-instrumentation-annotations-1.16 module, so that once a user opts into v3 preview these modules remain on even if otel.instrumentation.common.default-enabled=false. The helper is annotated @Deprecated for removal in 3.0.0, anticipating that the v3 behavior becomes the default.
Changes:
- Add
V3PreviewFallbackEnabledInstrumentationModulebase class (overrides bothdefaultEnabled()and the deprecateddefaultEnabled(ConfigProperties)). - Re-parent all
OpenTelemetryApi*InstrumentationModuleclasses andAnnotationInstrumentationModuleto the new base, with@SuppressWarnings("deprecation"). - Add tests: distribution-config YAML enables
v3_preview: true, a new test assertsAgentCommonConfig.isV3Preview(), andInstrumentationModuleInstallerTestcovers the fallback path via a mockedConfigProperties.
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| javaagent-extension-api/.../V3PreviewFallbackEnabledInstrumentationModule.java | New deprecated helper base class with v3-preview fallback for defaultEnabled. |
| javaagent-tooling/.../testDistributionConfig/.../AgentDistributionConfigTest.java | New test asserting isV3Preview() reflects YAML config. |
| javaagent-tooling/.../testDistributionConfig/resources/distribution-config.yaml | Adds v3_preview: true under instrumentation/development > java > common. |
| javaagent-tooling/.../InstrumentationModuleInstallerTest.java | Adds unit test of defaultEnabled(config) fallback and a TestInstrumentationModule subclass. |
| instrumentation/opentelemetry-instrumentation-annotations-1.16/.../AnnotationInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.0/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.10/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.15/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.27/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.31/.../incubator/OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.32/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.32/.../incubator/OpenTelemetryApiIncubatorInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.37/.../incubator/OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.38/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.38/.../incubator/OpenTelemetryApiIncubatorInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.4/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.40/.../incubator/OpenTelemetryApiIncubatorInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.42/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.42/.../incubator/OpenTelemetryApiIncubatorInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.47/.../incubator/OpenTelemetryApiIncubatorInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.50/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.50/.../incubator/OpenTelemetryApiIncubatorInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.56/.../incubator/OpenTelemetryApiIncubatorInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.57/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
| instrumentation/opentelemetry-api/opentelemetry-api-1.59/.../OpenTelemetryApiInstrumentationModule.java | Re-parented to v3-preview-fallback module. |
trask
force-pushed
the
default-instrumentation
branch
from
May 19, 2026 03:27
051868e to
da3f715
Compare
trask
force-pushed
the
default-instrumentation
branch
from
May 19, 2026 04:14
da3f715 to
faea1fc
Compare
laurit
approved these changes
May 19, 2026
SylvainJuge
pushed a commit
to SylvainJuge/opentelemetry-java-instrumentation
that referenced
this pull request
May 20, 2026
…s even when default-enabled is false (open-telemetry#18792)
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
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.
Resolves #7201