Simplify back-channel between spring-boot starter and spring library modules#18291
Merged
Conversation
otelbot-java-instrumentation
Bot
added
the
test native
trask
force-pushed
the
initializer
branch
2 times, most recently
from
47eb959 to
c1030eb
Compare
Each *BuilderUtil now exposes applyCommonConfig(builder, openTelemetry)
instead of getBuilderExtractor(). Receiving a *TelemetryBuilder instance
proves its <clinit> ran and registered the extractor, which lets callers
pass through CommonConfig without a public API change. Drop the now-unused
InstrumentationConfigUtil.configure{Server,Client}Builder helpers and
inline DbConfig.isQuerySanitizationEnabled at the four remaining call sites.
laurit
reviewed
Apr 27, 2026
| return builder; | ||
| } | ||
|
|
||
| @Initializer |
Contributor
There was a problem hiding this comment.
The idea is that since static initialization of SpringWebTelemetryBuilder calls setBuilderExtractor it is impossible to create and instance of SpringWebTelemetryBuilder so that the builderExtractor would be null.
Member
Author
There was a problem hiding this comment.
added comments
the reason I prefer this compared to using @Initializer is that there's no enforcement of @Initializer, so it's basically just a suppression mechanism
Member
Author
There was a problem hiding this comment.
I added requireNonNull() to make it clearer
# Conflicts: # instrumentation/spring/spring-web/spring-web-3.1/library/src/main/java/io/opentelemetry/instrumentation/spring/web/v3_1/internal/WebTelemetryUtil.java # instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/internal/SpringWebfluxBuilderUtil.java
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors how Spring Boot autoconfigure modules “reach into” Spring library builders to apply shared OpenTelemetry configuration, aiming to make initialization ordering more deterministic and align with patterns used by existing Experimental back-channels.
Changes:
- Replace “extractor getter + shared
InstrumentationConfigUtil” with library-ownedapply*CommonConfig(...)back-channel helpers for Spring WebMVC/WebFlux/Spring Web builders. - Remove
InstrumentationConfigUtiland update Spring Boot autoconfiguration to use the new helpers andDbConfigdirectly for query sanitization settings. - Update build wiring/comments to reflect the removal of shared starter-side config utilities.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/internal/SpringMvcBuilderUtil.java | Introduces builder back-channel helper to apply CommonConfig to the internal server builder. |
| instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/internal/SpringMvcBuilderUtil.java | Same as above for Spring WebMVC 5.3. |
| instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/internal/SpringWebfluxBuilderUtil.java | Adds client/server common-config application helpers and removes extractor getters. |
| instrumentation/spring/spring-web/spring-web-3.1/library/src/main/java/io/opentelemetry/instrumentation/spring/web/v3_1/internal/WebTelemetryUtil.java | Adds common-config application helper for Spring Web client builder and removes extractor getter. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring4/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestClientBeanPostProcessorSpring4.java | Switches to library-side common-config helper when building the interceptor. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring4/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/mongo/MongoClientInstrumentationSpringBoot4AutoConfiguration.java | Uses DbConfig directly for Mongo query sanitization configuration. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring3/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webmvc/SpringWebMvc6InstrumentationAutoConfiguration.java | Switches to library-side common-config helper when building the servlet filter. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring3/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestClientBeanPostProcessor.java | Switches to library-side common-config helper when building the interceptor. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/InstrumentationConfigUtil.java | Deleted (previously provided generic builder config + DbConfig delegation). |
| instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webmvc/SpringWebMvc5InstrumentationAutoConfiguration.java | Switches to library-side common-config helper when building the servlet filter. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webflux/WebClientBeanPostProcessor.java | Switches to library-side common-config helpers when building WebFlux client/server telemetry. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestTemplateInstrumentation.java | Switches to library-side common-config helper when building the interceptor. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/r2dbc/R2dbcInstrumentingPostProcessor.java | Uses DbConfig directly for R2DBC query sanitization configuration. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/mongo/MongoClientInstrumentationAutoConfiguration.java | Uses DbConfig directly for Mongo query sanitization configuration. |
| instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/jdbc/DataSourcePostProcessor.java | Uses DbConfig directly for JDBC query sanitization configuration. |
| instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts | Updates comment after removing the shared config utility. |
laurit
approved these changes
May 11, 2026
trask
added a commit
to trask/opentelemetry-java-instrumentation
that referenced
this pull request
May 12, 2026
Mark the field @nullable and use requireNonNull at the call site, matching the pattern used in open-telemetry#18291. Add a comment noting that the factory is registered in GrpcTelemetry's static initializer before any GrpcTelemetry instance can be passed here.
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.
Main motivation was to make the initialization order easier to reason about and more guaranteed. Also, this follow the pattern used in
Experimentalclasses.