Replace builder-extractor back-channel with applyCommonConfig pattern

trask · trask · commit 47eb9593fe93 · 2026-04-25T18:17:57.000-07:00
Each *BuilderUtil now exposes applyCommonConfig(builder, openTelemetry)

instead of getBuilderExtractor(). Receiving a *TelemetryBuilder instance

proves its &lt;clinit&gt; 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.
diff --git a/instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts b/instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts
@@ -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")
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/jdbc/DataSourcePostProcessor.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/jdbc/DataSourcePostProcessor.java
@@ -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;
@@ -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(
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/mongo/MongoClientInstrumentationAutoConfiguration.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/mongo/MongoClientInstrumentationAutoConfiguration.java
@@ -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;
@@ -33,7 +33,7 @@ MongoClientSettingsBuilderCustomizer customizer(OpenTelemetry openTelemetry) {
         builder.addCommandListener(
             MongoTelemetry.builder(openTelemetry)
                 .setQuerySanitizationEnabled(
-                    InstrumentationConfigUtil.isQuerySanitizationEnabled(openTelemetry, "mongo"))
+                    DbConfig.isQuerySanitizationEnabled(openTelemetry, "mongo"))
                 .build()
                 .createCommandListener());
   }
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/r2dbc/R2dbcInstrumentingPostProcessor.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/r2dbc/R2dbcInstrumentingPostProcessor.java
@@ -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;
@@ -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));
     }
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestTemplateInstrumentation.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestTemplateInstrumentation.java
@@ -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;
@@ -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();
 
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webflux/WebClientBeanPostProcessor.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webflux/WebClientBeanPostProcessor.java
@@ -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;
@@ -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();
   }
 
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webmvc/SpringWebMvc5InstrumentationAutoConfiguration.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webmvc/SpringWebMvc5InstrumentationAutoConfiguration.java
@@ -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;
@@ -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();
   }
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/InstrumentationConfigUtil.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/InstrumentationConfigUtil.java
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring3/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestClientBeanPostProcessor.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring3/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestClientBeanPostProcessor.java
@@ -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;
@@ -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();
   }
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring3/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webmvc/SpringWebMvc6InstrumentationAutoConfiguration.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring3/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/webmvc/SpringWebMvc6InstrumentationAutoConfiguration.java
@@ -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;
@@ -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();
   }
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring4/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/mongo/MongoClientInstrumentationSpringBoot4AutoConfiguration.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring4/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/mongo/MongoClientInstrumentationSpringBoot4AutoConfiguration.java
@@ -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;
@@ -30,7 +30,7 @@ MongoClientSettingsBuilderCustomizer customizer(OpenTelemetry openTelemetry) {
         builder.addCommandListener(
             MongoTelemetry.builder(openTelemetry)
                 .setQuerySanitizationEnabled(
-                    InstrumentationConfigUtil.isQuerySanitizationEnabled(openTelemetry, "mongo"))
+                    DbConfig.isQuerySanitizationEnabled(openTelemetry, "mongo"))
                 .build()
                 .createCommandListener());
   }
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring4/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestClientBeanPostProcessorSpring4.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/javaSpring4/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/web/RestClientBeanPostProcessorSpring4.java
@@ -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;
@@ -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();
   }
diff --git a/instrumentation/spring/spring-web/spring-web-3.1/library/src/main/java/io/opentelemetry/instrumentation/spring/web/v3_1/internal/WebTelemetryUtil.java b/instrumentation/spring/spring-web/spring-web-3.1/library/src/main/java/io/opentelemetry/instrumentation/spring/web/v3_1/internal/WebTelemetryUtil.java
@@ -5,34 +5,48 @@
 
 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 {
+public final class WebTelemetryUtil {
   private WebTelemetryUtil() {}
 
-  // allows access to the private field for the spring starter
-  private static volatile Function<
+  @Nullable
+  private static Function<
           SpringWebTelemetryBuilder,
           DefaultHttpClientInstrumenterBuilder<HttpRequest, ClientHttpResponse>>
       builderExtractor;
 
-  public static Function<
-          SpringWebTelemetryBuilder,
-          DefaultHttpClientInstrumenterBuilder<HttpRequest, ClientHttpResponse>>
-      getBuilderExtractor() {
-    return builderExtractor;
+  /**
+   * Applies common HTTP configuration (e.g. {@code otel.instrumentation.http.*} properties) derived
+   * from {@code openTelemetry} to {@code builder}.
+   */
+  @CanIgnoreReturnValue
+  public static SpringWebTelemetryBuilder applyCommonConfig(
+      SpringWebTelemetryBuilder builder, OpenTelemetry openTelemetry) {
+    // builderExtractor is non-null here: receiving a SpringWebTelemetryBuilder proves its class
+    // initializer has run and registered the extractor.
+    requireNonNull(builderExtractor).apply(builder).configure(new CommonConfig(openTelemetry));
+    return builder;
   }
 
-  @Initializer
   public static void setBuilderExtractor(
       Function<
               SpringWebTelemetryBuilder,
diff --git a/instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/internal/SpringWebfluxBuilderUtil.java b/instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/internal/SpringWebfluxBuilderUtil.java
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/internal/SpringMvcBuilderUtil.java b/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v5_3/internal/SpringMvcBuilderUtil.java
diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/internal/SpringMvcBuilderUtil.java b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/library/src/main/java/io/opentelemetry/instrumentation/spring/webmvc/v6_0/internal/SpringMvcBuilderUtil.java
