server for spring starter

Author: zeitlinger

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/instrumentation/webflux/SpringWebfluxInstrumentationAutoConfiguration.java

@@ -7,7 +7,7 @@
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
-import io.opentelemetry.instrumentation.spring.webflux.v5_3.SpringWebfluxTelemetry;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.context.annotation.Bean;
@@ -30,14 +30,14 @@ public SpringWebfluxInstrumentationAutoConfiguration() {}
   // static to avoid "is not eligible for getting processed by all BeanPostProcessors" warning
   @Bean
   static WebClientBeanPostProcessor otelWebClientBeanPostProcessor(
-      ObjectProvider<OpenTelemetry> openTelemetryProvider) {
-    return new WebClientBeanPostProcessor(openTelemetryProvider);
+      ObjectProvider<OpenTelemetry> openTelemetryProvider,
+      ObjectProvider<ConfigProperties> configPropertiesProvider) {
+    return new WebClientBeanPostProcessor(openTelemetryProvider, configPropertiesProvider);
   }
 
   @Bean
-  WebFilter telemetryFilter(OpenTelemetry openTelemetry) {
-    return SpringWebfluxTelemetry.builder(openTelemetry)
-        .build()
+  WebFilter telemetryFilter(OpenTelemetry openTelemetry, ConfigProperties config) {
+    return WebClientBeanPostProcessor.getWebfluxTelemetry(openTelemetry, config)
         .createWebFilterAndRegisterReactorHook();
   }
 }

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/instrumentation/webflux/WebClientBeanPostProcessor.java

@@ -6,7 +6,11 @@
 package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.webflux;
 
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.builder.internal.HttpServerInstrumenterBuilder;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.CommonConfigUtil;
 import io.opentelemetry.instrumentation.spring.webflux.v5_3.SpringWebfluxTelemetry;
+import io.opentelemetry.instrumentation.spring.webflux.v5_3.SpringWebfluxTelemetryBuilder;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.beans.factory.config.BeanPostProcessor;
 import org.springframework.web.reactive.function.client.WebClient;
@@ -19,9 +23,20 @@
 final class WebClientBeanPostProcessor implements BeanPostProcessor {
 
   private final ObjectProvider<OpenTelemetry> openTelemetryProvider;
+  private final ObjectProvider<ConfigProperties> configPropertiesProvider;
 
-  WebClientBeanPostProcessor(ObjectProvider<OpenTelemetry> openTelemetryProvider) {
+  WebClientBeanPostProcessor(
+      ObjectProvider<OpenTelemetry> openTelemetryProvider,
+      ObjectProvider<ConfigProperties> configPropertiesProvider) {
     this.openTelemetryProvider = openTelemetryProvider;
+    this.configPropertiesProvider = configPropertiesProvider;
+  }
+
+  static SpringWebfluxTelemetry getWebfluxTelemetry(
+      OpenTelemetry openTelemetry, ConfigProperties config) {
+    SpringWebfluxTelemetryBuilder builder = SpringWebfluxTelemetry.builder(openTelemetry);
+    HttpServerInstrumenterBuilder.configure(CommonConfigUtil.getCommonConfig(config), builder);
+    return builder.build();
   }
 
   @Override
@@ -38,7 +53,8 @@ public Object postProcessAfterInitialization(Object bean, String beanName) {
 
   private WebClient.Builder wrapBuilder(WebClient.Builder webClientBuilder) {
     SpringWebfluxTelemetry instrumentation =
-        SpringWebfluxTelemetry.create(openTelemetryProvider.getObject());
+        getWebfluxTelemetry(
+            openTelemetryProvider.getObject(), configPropertiesProvider.getObject());
     return webClientBuilder.filters(instrumentation::addClientTracingFilter);
   }
 }

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/instrumentation/webmvc/SpringWebMvc5InstrumentationAutoConfiguration.java

@@ -6,8 +6,12 @@
 package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.webmvc;
 
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.builder.internal.HttpServerInstrumenterBuilder;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.CommonConfigUtil;
 import io.opentelemetry.instrumentation.spring.webmvc.v5_3.SpringWebMvcTelemetry;
+import io.opentelemetry.instrumentation.spring.webmvc.v5_3.SpringWebMvcTelemetryBuilder;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import javax.servlet.Filter;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.context.annotation.Bean;
@@ -22,7 +26,9 @@
 public class SpringWebMvc5InstrumentationAutoConfiguration {
 
   @Bean
-  Filter otelWebMvcFilter(OpenTelemetry openTelemetry) {
-    return SpringWebMvcTelemetry.create(openTelemetry).createServletFilter();
+  Filter otelWebMvcFilter(OpenTelemetry openTelemetry, ConfigProperties config) {
+    SpringWebMvcTelemetryBuilder builder = SpringWebMvcTelemetry.builder(openTelemetry);
+    HttpServerInstrumenterBuilder.configure(CommonConfigUtil.getCommonConfig(config), builder);
+    return builder.build().createServletFilter();
   }
 }

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/instrumentation/webmvc/SpringWebMvc6InstrumentationAutoConfiguration.java

@@ -6,8 +6,12 @@
 package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.webmvc;
 
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.builder.internal.HttpServerInstrumenterBuilder;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.CommonConfigUtil;
 import io.opentelemetry.instrumentation.spring.webmvc.v6_0.SpringWebMvcTelemetry;
+import io.opentelemetry.instrumentation.spring.webmvc.v6_0.SpringWebMvcTelemetryBuilder;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import jakarta.servlet.Filter;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.context.annotation.Bean;
@@ -22,7 +26,9 @@
 public class SpringWebMvc6InstrumentationAutoConfiguration {
 
   @Bean
-  Filter otelWebMvcFilter(OpenTelemetry openTelemetry) {
-    return SpringWebMvcTelemetry.create(openTelemetry).createServletFilter();
+  Filter otelWebMvcFilter(OpenTelemetry openTelemetry, ConfigProperties config) {
+    SpringWebMvcTelemetryBuilder builder = SpringWebMvcTelemetry.builder(openTelemetry);
+    HttpServerInstrumenterBuilder.configure(CommonConfigUtil.getCommonConfig(config), builder);
+    return builder.build().createServletFilter();
   }
 }

instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -306,6 +306,22 @@
       "description": "Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as <code>_OTHER</code>.",
       "defaultValue": "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
     },
+    {
+      "name": "otel.instrumentation.http.server.capture-request-headers",
+      "type": "java.util.List<java.lang.String>",
+      "description": "List of HTTP request headers to capture in HTTP servers."
+    },
+    {
+      "name": "otel.instrumentation.http.server.capture-response-headers",
+      "type": "java.util.List<java.lang.String>",
+      "description": "List of HTTP response headers to capture in HTTP servers."
+    },
+    {
+      "name": "otel.instrumentation.http.server.emit-experimental-telemetry",
+      "type": "java.lang.Boolean",
+      "description": "Enable the capture of experimental HTTP server telemetry. Add the <code>http.request.body.size</code> and <code>http.response.body.size> attributes to spans, and record the <code>http.server.request.size</code> and <code>http.server.response.size</code> metrics.",
+      "defaultValue": false
+    },
     {
       "name": "otel.instrumentation.jdbc.enabled",
       "type": "java.lang.Boolean",

instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/instrumentation/webflux/SpringWebfluxInstrumentationAutoConfigurationTest.java

@@ -8,6 +8,9 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
+import java.util.Collections;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
@@ -17,6 +20,9 @@ class SpringWebfluxInstrumentationAutoConfigurationTest {
   private final ApplicationContextRunner contextRunner =
       new ApplicationContextRunner()
           .withBean(OpenTelemetry.class, OpenTelemetry::noop)
+          .withBean(
+              ConfigProperties.class,
+              () -> DefaultConfigProperties.createFromMap(Collections.emptyMap()))
           .withConfiguration(
               AutoConfigurations.of(SpringWebfluxInstrumentationAutoConfiguration.class));
 

instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/instrumentation/webflux/WebClientBeanPostProcessorTest.java

@@ -8,6 +8,9 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
+import java.util.Collections;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.config.BeanPostProcessor;
@@ -20,14 +23,18 @@ class WebClientBeanPostProcessorTest {
 
   static {
     beanFactory.registerSingleton("openTelemetry", OpenTelemetry.noop());
+    beanFactory.registerSingleton(
+        "configProperties", DefaultConfigProperties.createFromMap(Collections.emptyMap()));
   }
 
   @Test
   @DisplayName(
       "when processed bean is NOT of type WebClient or WebClientBuilder should return Object")
   void returnsObject() {
     BeanPostProcessor underTest =
-        new WebClientBeanPostProcessor(beanFactory.getBeanProvider(OpenTelemetry.class));
+        new WebClientBeanPostProcessor(
+            beanFactory.getBeanProvider(OpenTelemetry.class),
+            beanFactory.getBeanProvider(ConfigProperties.class));
 
     assertThat(underTest.postProcessAfterInitialization(new Object(), "testObject"))
         .isExactlyInstanceOf(Object.class);
@@ -37,7 +44,9 @@ void returnsObject() {
   @DisplayName("when processed bean is of type WebClient should return WebClient")
   void returnsWebClient() {
     BeanPostProcessor underTest =
-        new WebClientBeanPostProcessor(beanFactory.getBeanProvider(OpenTelemetry.class));
+        new WebClientBeanPostProcessor(
+            beanFactory.getBeanProvider(OpenTelemetry.class),
+            beanFactory.getBeanProvider(ConfigProperties.class));
 
     assertThat(underTest.postProcessAfterInitialization(WebClient.create(), "testWebClient"))
         .isInstanceOf(WebClient.class);
@@ -47,7 +56,9 @@ void returnsWebClient() {
   @DisplayName("when processed bean is of type WebClientBuilder should return WebClientBuilder")
   void returnsWebClientBuilder() {
     BeanPostProcessor underTest =
-        new WebClientBeanPostProcessor(beanFactory.getBeanProvider(OpenTelemetry.class));
+        new WebClientBeanPostProcessor(
+            beanFactory.getBeanProvider(OpenTelemetry.class),
+            beanFactory.getBeanProvider(ConfigProperties.class));
 
     assertThat(
             underTest.postProcessAfterInitialization(WebClient.builder(), "testWebClientBuilder"))
@@ -58,7 +69,9 @@ void returnsWebClientBuilder() {
   @DisplayName("when processed bean is of type WebClient should add exchange filter to WebClient")
   void addsExchangeFilterWebClient() {
     BeanPostProcessor underTest =
-        new WebClientBeanPostProcessor(beanFactory.getBeanProvider(OpenTelemetry.class));
+        new WebClientBeanPostProcessor(
+            beanFactory.getBeanProvider(OpenTelemetry.class),
+            beanFactory.getBeanProvider(ConfigProperties.class));
 
     WebClient webClient = WebClient.create();
     Object processedWebClient =
@@ -81,7 +94,9 @@ void addsExchangeFilterWebClient() {
       "when processed bean is of type WebClientBuilder should add ONE exchange filter to WebClientBuilder")
   void addsExchangeFilterWebClientBuilder() {
     BeanPostProcessor underTest =
-        new WebClientBeanPostProcessor(beanFactory.getBeanProvider(OpenTelemetry.class));
+        new WebClientBeanPostProcessor(
+            beanFactory.getBeanProvider(OpenTelemetry.class),
+            beanFactory.getBeanProvider(ConfigProperties.class));
 
     WebClient.Builder webClientBuilder = WebClient.builder();
     underTest.postProcessAfterInitialization(webClientBuilder, "testWebClientBuilder");