Configure OtlpGrpcSpanExporter bean (#148)

Author: mfvanek

spring-boot-3-demo-app/build.gradle.kts

@@ -1,14 +1,14 @@
 plugins {
     id("sb-ot-demo.java-conventions")
     id("sb-ot-demo.docker")
-    id("org.springframework.boot") version "3.2.5"
+    id("org.springframework.boot") version "3.3.2"
     id("io.freefair.lombok")
 }
 
 dependencies {
     implementation(platform(project(":common-internal-bom")))
-    implementation(platform("org.springdoc:springdoc-openapi:2.3.0"))
-    implementation(platform("org.springframework.boot:spring-boot-dependencies:3.2.5"))
+    implementation(platform("org.springdoc:springdoc-openapi:2.6.0"))
+    implementation(platform("org.springframework.boot:spring-boot-dependencies:3.3.2"))
 
     implementation("org.springframework.boot:spring-boot-starter-web")
     implementation("org.springframework.boot:spring-boot-starter-actuator")

spring-boot-3-demo-app/src/main/java/io/github/mfvanek/spring/boot3/test/config/OpenTelemetryConfig.java

@@ -1,20 +1,30 @@
 package io.github.mfvanek.spring.boot3.test.config;
 
 import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
-import org.springframework.beans.factory.annotation.Value;
+import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder;
+import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpAutoConfiguration;
+import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpProperties;
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 import javax.annotation.Nonnull;
+import java.util.Locale;
 
+@AutoConfigureBefore(OtlpAutoConfiguration.class)
 @Configuration(proxyBeanMethods = false)
-public class OpenTelemetryConfig {
+class OpenTelemetryConfig {
 
+    // Waiting for https://github.com/spring-projects/spring-boot/pull/41213
     @Bean
-    OtlpGrpcSpanExporter otelJaegerGrpcSpanExporter(
-            @Value("${management.otlp.metrics.export.url}") final @Nonnull String endpoint) {
-        return OtlpGrpcSpanExporter.builder()
-                .setEndpoint(endpoint)
-                .build();
+    @ConditionalOnMissingBean(OtlpGrpcSpanExporter.class)
+    OtlpGrpcSpanExporter otelJaegerGrpcSpanExporter(@Nonnull final OtlpProperties otlpProperties) {
+        OtlpGrpcSpanExporterBuilder builder = OtlpGrpcSpanExporter.builder()
+                .setEndpoint(otlpProperties.getEndpoint())
+                .setTimeout(otlpProperties.getTimeout())
+                .setCompression(String.valueOf(otlpProperties.getCompression()).toLowerCase(Locale.ROOT));
+        otlpProperties.getHeaders().forEach(builder::addHeader);
+        return builder.build();
     }
 }

spring-boot-3-demo-app/src/main/resources/application.yml

@@ -71,9 +71,9 @@ management:
             slo:
                 http.server.requests: 1s
     health:
-        livenessstate:
+        livenessState:
             enabled: true
-        readinessstate:
+        readinessState:
             enabled: true
     prometheus:
         metrics:
@@ -88,9 +88,10 @@ management:
         sampling:
             probability: 1.0
     otlp:
-        metrics:
-            export:
-                url: http://localhost:4317
+        tracing:
+            endpoint: http://localhost:4317
+            compression: none
+            timeout: 5s
 
 springdoc:
     show-actuator: true
@@ -101,4 +102,4 @@ springdoc:
 spring:
     config.activate.on-profile: docker
     kafka.bootstrap-servers: kafka1:29092
-management.otlp.metrics.export.url: http://jaeger:4317
+management.otlp.tracing.endpoint: http://jaeger:4317

spring-boot-3-demo-app/src/test/java/io/github/mfvanek/spring/boot3/test/ApplicationTests.java

@@ -1,14 +1,18 @@
 package io.github.mfvanek.spring.boot3.test;
 
+import io.github.mfvanek.spring.boot3.test.support.JaegerInitializer;
 import io.github.mfvanek.spring.boot3.test.support.TestBase;
 import io.micrometer.observation.ObservationRegistry;
 import io.micrometer.tracing.Span;
 import io.micrometer.tracing.Tracer;
 import io.micrometer.tracing.otel.bridge.OtelTracer;
+import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationContext;
 
+import java.util.Locale;
+
 import static org.assertj.core.api.Assertions.assertThat;
 
 class ApplicationTests extends TestBase {
@@ -28,5 +32,13 @@ void contextLoads() {
                 .isInstanceOf(OtelTracer.class)
                 .satisfies(t -> assertThat(t.currentSpan())
                         .isNotEqualTo(Span.NOOP));
+        assertThat(applicationContext.getBean("otelJaegerGrpcSpanExporter"))
+                .isNotNull()
+                .isInstanceOf(OtlpGrpcSpanExporter.class)
+                .hasToString(String.format(Locale.ROOT, "OtlpGrpcSpanExporter{exporterName=otlp, type=span, " +
+                        "endpoint=http://localhost:%d, " +
+                        "endpointPath=/opentelemetry.proto.collector.trace.v1.TraceService/Export, timeoutNanos=5000000000, " +
+                        "connectTimeoutNanos=10000000000, compressorEncoding=null, " +
+                        "headers=Headers{User-Agent=OBFUSCATED}}", JaegerInitializer.getFirstMappedPort()));
     }
 }

spring-boot-3-demo-app/src/test/java/io/github/mfvanek/spring/boot3/test/support/JaegerInitializer.java

@@ -6,6 +6,8 @@
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.utility.DockerImageName;
 
+import javax.annotation.Nonnull;
+
 @SuppressWarnings("resource")
 public class JaegerInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
 
@@ -19,7 +21,12 @@ public void initialize(final ConfigurableApplicationContext context) {
 
         final String jaegerUrl = "http://localhost:" + JAEGER.getFirstMappedPort();
         TestPropertyValues.of(
-                "management.otlp.metrics.export.url=" + jaegerUrl
+                "management.otlp.tracing.endpoint=" + jaegerUrl
         ).applyTo(context.getEnvironment());
     }
+
+    @Nonnull
+    public static Integer getFirstMappedPort() {
+        return JAEGER.getFirstMappedPort();
+    }
 }