Skip to content

Simplify back-channel between spring-boot starter and spring library modules #18291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trask merged 6 commits into from
May 11, 2026
Merged

Simplify back-channel between spring-boot starter and spring library modules #18291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f67c9b3
Replace builder-extractor back-channel with applyCommonConfig pattern
trask Apr 25, 2026
4ad8436
Merge branch 'main' into initializer
trask Apr 27, 2026
0429d64
Merge remote-tracking branch 'upstream/main' into initializer
trask Apr 29, 2026
2f0600f
comment
trask Apr 29, 2026
0ae0acd
Fail fast when Spring builder extractors are missing
trask May 9, 2026
ead7e53
Merge branch 'main' into initializer
trask May 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ dependencies {
// needed for the Spring Boot 3 support
implementation(project(":instrumentation:spring:spring-webmvc:spring-webmvc-6.0:library"))

// give access to common classes, e.g. InstrumentationConfigUtil
// give access to common classes
add("javaSpring3CompileOnly", files(sourceSets.main.get().output.classesDirs))
add("javaSpring3CompileOnly", "org.springframework.boot:spring-boot-starter-web:3.2.4")
add("javaSpring3CompileOnly", "io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
Expand Down
4 changes: 2 additions & 2 deletions ...mentation/spring/autoconfigure/internal/instrumentation/jdbc/DataSourcePostProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
import io.opentelemetry.instrumentation.api.incubator.config.internal.DbConfig;
import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil;
import io.opentelemetry.instrumentation.jdbc.datasource.JdbcTelemetry;
import io.opentelemetry.instrumentation.jdbc.datasource.JdbcTelemetryBuilder;
import io.opentelemetry.instrumentation.jdbc.datasource.internal.Experimental;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import java.io.PrintWriter;
import java.sql.Connection;
import java.sql.SQLException;
Expand Down Expand Up @@ -64,7 +64,7 @@ public Object postProcessAfterInitialization(Object bean, String beanName) {
JdbcTelemetryBuilder builder =
JdbcTelemetry.builder(openTelemetry)
.setQuerySanitizationEnabled(
InstrumentationConfigUtil.isQuerySanitizationEnabled(openTelemetry, "jdbc"))
DbConfig.isQuerySanitizationEnabled(openTelemetry, "jdbc"))
.setCaptureQueryParameters(
config.getBoolean("capture_query_parameters/development", false))
.setTransactionInstrumenterEnabled(
Expand Down
4 changes: 2 additions & 2 deletions ...configure/internal/instrumentation/mongo/MongoClientInstrumentationAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

import com.mongodb.MongoClientSettings;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.api.incubator.config.internal.DbConfig;
import io.opentelemetry.instrumentation.mongo.v3_1.MongoTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.mongo.MongoClientSettingsBuilderCustomizer;
import org.springframework.context.annotation.Bean;
Expand All @@ -33,7 +33,7 @@ MongoClientSettingsBuilderCustomizer customizer(OpenTelemetry openTelemetry) {
builder.addCommandListener(
MongoTelemetry.builder(openTelemetry)
.setQuerySanitizationEnabled(
InstrumentationConfigUtil.isQuerySanitizationEnabled(openTelemetry, "mongo"))
DbConfig.isQuerySanitizationEnabled(openTelemetry, "mongo"))
.build()
.createCommandListener());
}
Expand Down
5 changes: 2 additions & 3 deletions .../spring/autoconfigure/internal/instrumentation/r2dbc/R2dbcInstrumentingPostProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.r2dbc;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.api.incubator.config.internal.DbConfig;
import io.opentelemetry.instrumentation.r2dbc.v1_0.internal.shaded.R2dbcTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import io.r2dbc.spi.ConnectionFactory;
import io.r2dbc.spi.ConnectionFactoryOptions;
import org.springframework.aop.scope.ScopedProxyUtils;
Expand All @@ -29,8 +29,7 @@ public Object postProcessAfterInitialization(Object bean, String beanName) {
ConnectionFactory connectionFactory = (ConnectionFactory) bean;
OpenTelemetry openTelemetry = openTelemetryProvider.getObject();
return R2dbcTelemetry.builder(openTelemetry)
.setQuerySanitizationEnabled(
InstrumentationConfigUtil.isQuerySanitizationEnabled(openTelemetry, "r2dbc"))
.setQuerySanitizationEnabled(DbConfig.isQuerySanitizationEnabled(openTelemetry, "r2dbc"))
.build()
.wrapConnectionFactory(connectionFactory, getConnectionFactoryOptions(connectionFactory));
}
Expand Down
6 changes: 1 addition & 5 deletions ...tation/spring/autoconfigure/internal/instrumentation/web/RestTemplateInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import io.opentelemetry.instrumentation.spring.web.v3_1.SpringWebTelemetry;
import io.opentelemetry.instrumentation.spring.web.v3_1.internal.WebTelemetryUtil;
import java.util.List;
Expand All @@ -22,10 +21,7 @@ private RestTemplateInstrumentation() {}
static RestTemplate addIfNotPresent(RestTemplate restTemplate, OpenTelemetry openTelemetry) {

ClientHttpRequestInterceptor instrumentationInterceptor =
InstrumentationConfigUtil.configureClientBuilder(
openTelemetry,
SpringWebTelemetry.builder(openTelemetry),
WebTelemetryUtil.getBuilderExtractor())
WebTelemetryUtil.applyCommonConfig(SpringWebTelemetry.builder(openTelemetry), openTelemetry)
.build()
.createInterceptor();

Expand Down
13 changes: 4 additions & 9 deletions ...ion/spring/autoconfigure/internal/instrumentation/webflux/WebClientBeanPostProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.webflux;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import io.opentelemetry.instrumentation.spring.webflux.v5_3.SpringWebfluxClientTelemetry;
import io.opentelemetry.instrumentation.spring.webflux.v5_3.SpringWebfluxServerTelemetry;
import io.opentelemetry.instrumentation.spring.webflux.v5_3.internal.SpringWebfluxBuilderUtil;
Expand All @@ -32,18 +31,14 @@ final class WebClientBeanPostProcessor implements BeanPostProcessor {
}

static SpringWebfluxClientTelemetry getWebfluxClientTelemetry(OpenTelemetry openTelemetry) {
return InstrumentationConfigUtil.configureClientBuilder(
openTelemetry,
SpringWebfluxClientTelemetry.builder(openTelemetry),
SpringWebfluxBuilderUtil.getClientBuilderExtractor())
return SpringWebfluxBuilderUtil.applyClientCommonConfig(
SpringWebfluxClientTelemetry.builder(openTelemetry), openTelemetry)
.build();
}

static SpringWebfluxServerTelemetry getWebfluxServerTelemetry(OpenTelemetry openTelemetry) {
return InstrumentationConfigUtil.configureServerBuilder(
openTelemetry,
SpringWebfluxServerTelemetry.builder(openTelemetry),
SpringWebfluxBuilderUtil.getServerBuilderExtractor())
return SpringWebfluxBuilderUtil.applyServerCommonConfig(
SpringWebfluxServerTelemetry.builder(openTelemetry), openTelemetry)
.build();
}

Expand Down
7 changes: 2 additions & 5 deletions ...figure/internal/instrumentation/webmvc/SpringWebMvc5InstrumentationAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import io.opentelemetry.instrumentation.spring.webmvc.v5_3.SpringWebMvcTelemetry;
import io.opentelemetry.instrumentation.spring.webmvc.v5_3.internal.SpringMvcBuilderUtil;
import javax.servlet.Filter;
Expand All @@ -28,10 +27,8 @@ public class SpringWebMvc5InstrumentationAutoConfiguration {

@Bean
Filter otelWebMvcFilter(OpenTelemetry openTelemetry) {
return InstrumentationConfigUtil.configureServerBuilder(
openTelemetry,
SpringWebMvcTelemetry.builder(openTelemetry),
SpringMvcBuilderUtil.getBuilderExtractor())
return SpringMvcBuilderUtil.applyCommonConfig(
SpringWebMvcTelemetry.builder(openTelemetry), openTelemetry)
.build()
.createServletFilter();
}
Expand Down
49 changes: 0 additions & 49 deletions ...y/instrumentation/spring/autoconfigure/internal/properties/InstrumentationConfigUtil.java
View file
Open in desktop

This file was deleted.

7 changes: 2 additions & 5 deletions ...tation/spring/autoconfigure/internal/instrumentation/web/RestClientBeanPostProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.web;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import io.opentelemetry.instrumentation.spring.web.v3_1.SpringWebTelemetry;
import io.opentelemetry.instrumentation.spring.web.v3_1.internal.WebTelemetryUtil;
import java.util.List;
Expand Down Expand Up @@ -59,10 +58,8 @@ private static boolean isInterceptorNotPresent(
}

static ClientHttpRequestInterceptor getInterceptor(OpenTelemetry openTelemetry) {
return InstrumentationConfigUtil.configureClientBuilder(
openTelemetry,
SpringWebTelemetry.builder(openTelemetry),
WebTelemetryUtil.getBuilderExtractor())
return WebTelemetryUtil.applyCommonConfig(
SpringWebTelemetry.builder(openTelemetry), openTelemetry)
.build()
.createInterceptor();
}
Expand Down
7 changes: 2 additions & 5 deletions ...figure/internal/instrumentation/webmvc/SpringWebMvc6InstrumentationAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import io.opentelemetry.instrumentation.spring.webmvc.v6_0.SpringWebMvcTelemetry;
import io.opentelemetry.instrumentation.spring.webmvc.v6_0.internal.SpringMvcBuilderUtil;
import jakarta.servlet.Filter;
Expand All @@ -28,10 +27,8 @@ public class SpringWebMvc6InstrumentationAutoConfiguration {

@Bean
Filter otelWebMvcFilter(OpenTelemetry openTelemetry) {
return InstrumentationConfigUtil.configureServerBuilder(
openTelemetry,
SpringWebMvcTelemetry.builder(openTelemetry),
SpringMvcBuilderUtil.getBuilderExtractor())
return SpringMvcBuilderUtil.applyCommonConfig(
SpringWebMvcTelemetry.builder(openTelemetry), openTelemetry)
.build()
.createServletFilter();
}
Expand Down
4 changes: 2 additions & 2 deletions ...nternal/instrumentation/mongo/MongoClientInstrumentationSpringBoot4AutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

import com.mongodb.MongoClientSettings;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.api.incubator.config.internal.DbConfig;
import io.opentelemetry.instrumentation.mongo.v3_1.MongoTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.mongodb.autoconfigure.MongoClientSettingsBuilderCustomizer;
import org.springframework.context.annotation.Bean;
Expand All @@ -30,7 +30,7 @@ MongoClientSettingsBuilderCustomizer customizer(OpenTelemetry openTelemetry) {
builder.addCommandListener(
MongoTelemetry.builder(openTelemetry)
.setQuerySanitizationEnabled(
InstrumentationConfigUtil.isQuerySanitizationEnabled(openTelemetry, "mongo"))
DbConfig.isQuerySanitizationEnabled(openTelemetry, "mongo"))
.build()
.createCommandListener());
}
Expand Down
7 changes: 2 additions & 5 deletions ...spring/autoconfigure/internal/instrumentation/web/RestClientBeanPostProcessorSpring4.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.web;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
import io.opentelemetry.instrumentation.spring.web.v3_1.SpringWebTelemetry;
import io.opentelemetry.instrumentation.spring.web.v3_1.internal.WebTelemetryUtil;
import java.util.List;
Expand Down Expand Up @@ -59,10 +58,8 @@ private static boolean isInterceptorNotPresent(
}

static ClientHttpRequestInterceptor getInterceptor(OpenTelemetry openTelemetry) {
return InstrumentationConfigUtil.configureClientBuilder(
openTelemetry,
SpringWebTelemetry.builder(openTelemetry),
WebTelemetryUtil.getBuilderExtractor())
return WebTelemetryUtil.applyCommonConfig(
SpringWebTelemetry.builder(openTelemetry), openTelemetry)
.build()
.createInterceptor();
}
Expand Down
34 changes: 23 additions & 11 deletions ...main/java/io/opentelemetry/instrumentation/spring/web/v3_1/internal/WebTelemetryUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,44 @@

package io.opentelemetry.instrumentation.spring.web.v3_1.internal;

import static java.util.Objects.requireNonNull;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.api.incubator.builder.internal.DefaultHttpClientInstrumenterBuilder;
import io.opentelemetry.instrumentation.api.internal.Initializer;
import io.opentelemetry.instrumentation.api.incubator.config.internal.CommonConfig;
import io.opentelemetry.instrumentation.spring.web.v3_1.SpringWebTelemetryBuilder;
import java.util.function.Function;
import javax.annotation.Nullable;
import org.springframework.http.HttpRequest;
import org.springframework.http.client.ClientHttpResponse;

/**
* This class is internal and is hence not for public use. Its APIs are unstable and can change at
* any time.
* Back-channel between the {@code spring-web-3.1} library and the {@code spring-boot-autoconfigure}
* starter, used to configure the {@code DefaultHttpClientInstrumenterBuilder} held in a private
* field of {@link SpringWebTelemetryBuilder} without exposing it as public API.
*
* <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
* at any time.
*/
public class WebTelemetryUtil {
// allows access to the private field for the spring starter
public final class WebTelemetryUtil {
@Nullable
private static volatile Function<
SpringWebTelemetryBuilder,
DefaultHttpClientInstrumenterBuilder<HttpRequest, ClientHttpResponse>>
builderExtractor;

public static Function<
SpringWebTelemetryBuilder,
DefaultHttpClientInstrumenterBuilder<HttpRequest, ClientHttpResponse>>
getBuilderExtractor() {
return builderExtractor;
@CanIgnoreReturnValue
public static SpringWebTelemetryBuilder applyCommonConfig(
SpringWebTelemetryBuilder builder, OpenTelemetry openTelemetry) {
// builderExtractor is guaranteed non-null because the builder class registers it during
// static initialization, before a builder instance can be passed here
requireNonNull(builderExtractor, "builderExtractor")
.apply(builder)
.configure(new CommonConfig(openTelemetry));
return builder;
}

@Initializer
Copy link
Copy Markdown
Contributor

@laurit laurit Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

@trask trask Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member Author

@trask trask May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added requireNonNull() to make it clearer

public static void setBuilderExtractor(
Function<
SpringWebTelemetryBuilder,
Expand Down
Loading
Loading