Split spring-boot-micrometer-tracing into Brave and OpenTelemetry specific module

Closes gh-47953

Author: mhalbritter

configuration-metadata/spring-boot-configuration-metadata-changelog-generator/build.gradle

@@ -104,6 +104,8 @@ def dependenciesOf(String version) {
 			"spring-boot-micrometer-metrics-test",
 			"spring-boot-micrometer-observation",
 			"spring-boot-micrometer-tracing",
+			"spring-boot-micrometer-tracing-brave",
+			"spring-boot-micrometer-tracing-opentelemetry",
 			"spring-boot-micrometer-tracing-test",
 			"spring-boot-mongodb",
 			"spring-boot-mustache",

documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/tracing.adoc

@@ -136,9 +136,9 @@ Tracing with OpenTelemetry and reporting using OTLP requires the following depen
 * `io.micrometer:micrometer-tracing-bridge-otel` - bridges the Micrometer Observation API to OpenTelemetry.
 * `io.opentelemetry:opentelemetry-exporter-otlp` - reports traces to a collector that can accept OTLP.
 
-Use the `management.otlp.tracing.*` configuration properties to configure reporting using OTLP.
+Use the `management.opentelemetry.tracing.export.otlp.*` configuration properties to configure reporting using OTLP.
 
-NOTE: If you need to apply advanced customizations to OTLP span exporters, consider registering javadoc:org.springframework.boot.micrometer.tracing.autoconfigure.otlp.OtlpHttpSpanExporterBuilderCustomizer[] or javadoc:org.springframework.boot.micrometer.tracing.autoconfigure.otlp.OtlpGrpcSpanExporterBuilderCustomizer[] beans.
+NOTE: If you need to apply advanced customizations to OTLP span exporters, consider registering javadoc:org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpHttpSpanExporterBuilderCustomizer[] or javadoc:org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpGrpcSpanExporterBuilderCustomizer[] beans.
 These will be invoked before the creation of the `OtlpHttpSpanExporter` or `OtlpGrpcSpanExporter`.
 The customizers take precedence over anything applied by the auto-configuration.
 

documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/dev-services.adoc

@@ -116,7 +116,7 @@ The following service connections are currently supported:
 | javadoc:org.springframework.boot.micrometer.metrics.autoconfigure.export.otlp.OtlpMetricsConnectionDetails[]
 | Containers named "otel/opentelemetry-collector-contrib", "grafana/otel-lgtm"
 
-| javadoc:org.springframework.boot.micrometer.tracing.autoconfigure.otlp.OtlpTracingConnectionDetails[]
+| javadoc:org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpTracingConnectionDetails[]
 | Containers named "otel/opentelemetry-collector-contrib", "grafana/otel-lgtm"
 
 | javadoc:org.springframework.boot.pulsar.autoconfigure.PulsarConnectionDetails[]

documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc

@@ -161,7 +161,7 @@ The following service connection factories are provided in the `spring-boot-test
 | javadoc:org.springframework.boot.micrometer.metrics.autoconfigure.export.otlp.OtlpMetricsConnectionDetails[]
 | Containers named "otel/opentelemetry-collector-contrib" or of type javadoc:org.testcontainers.grafana.LgtmStackContainer[]
 
-| javadoc:org.springframework.boot.micrometer.tracing.autoconfigure.otlp.OtlpTracingConnectionDetails[]
+| javadoc:org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpTracingConnectionDetails[]
 | Containers named "otel/opentelemetry-collector-contrib" or of type javadoc:org.testcontainers.grafana.LgtmStackContainer[]
 
 | javadoc:org.springframework.boot.pulsar.autoconfigure.PulsarConnectionDetails[]

module/spring-boot-autoconfigure-classic-modules/build.gradle

@@ -175,6 +175,12 @@ dependencies {
 	api(project(":module:spring-boot-micrometer-tracing")) {
 		transitive = false
 	}
+	api(project(":module:spring-boot-micrometer-tracing-brave")) {
+		transitive = false
+	}
+	api(project(":module:spring-boot-micrometer-tracing-opentelemetry")) {
+		transitive = false
+	}
 	api(project(":module:spring-boot-mongodb")) {
 		transitive = false
 	}

module/spring-boot-micrometer-tracing-brave/build.gradle

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2012-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+plugins {
+	id "java-library"
+	id "org.springframework.boot.auto-configuration"
+	id "org.springframework.boot.configuration-properties"
+	id "org.springframework.boot.deployed"
+	id "org.springframework.boot.docker-test"
+	id "org.springframework.boot.optional-dependencies"
+}
+
+description = "Spring Boot Tracing Brave"
+
+dependencies {
+	api(project(":core:spring-boot"))
+	api(project(":module:spring-boot-micrometer-observation"))
+	api(project(":module:spring-boot-micrometer-tracing"))
+	api("io.micrometer:micrometer-tracing") {
+		exclude(group: "aopalliance", module: "aopalliance")
+	}
+	optional(project(":core:spring-boot-autoconfigure"))
+	optional(project(":module:spring-boot-zipkin"))
+	optional("io.micrometer:micrometer-tracing-bridge-brave")
+	optional("io.zipkin.reporter2:zipkin-reporter-brave")
+
+	testImplementation(project(":core:spring-boot-test"))
+	testImplementation(project(":test-support:spring-boot-test-support"))
+	testImplementation(project(":module:spring-boot-micrometer-metrics"))
+	testImplementation("io.micrometer:micrometer-registry-prometheus")
+	testImplementation("io.prometheus:prometheus-metrics-exposition-formats")
+
+	testRuntimeOnly("ch.qos.logback:logback-classic")
+}
+
+tasks.named("compileTestJava") {
+	options.nullability.checking = "tests"
+}
+
+tasks.named("compileDockerTestJava") {
+	options.nullability.checking = "tests"
+}

module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/BraveAutoConfiguration.java renamed to module/spring-boot-micrometer-tracing-brave/src/main/java/org/springframework/boot/micrometer/tracing/brave/autoconfigure/BraveAutoConfiguration.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.micrometer.tracing.autoconfigure;
+package org.springframework.boot.micrometer.tracing.brave.autoconfigure;
 
 import java.util.List;
 
@@ -47,6 +47,9 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.context.properties.IncompatibleConfigurationException;
+import org.springframework.boot.micrometer.tracing.autoconfigure.MicrometerTracingAutoConfiguration;
+import org.springframework.boot.micrometer.tracing.autoconfigure.NoopTracerAutoConfiguration;
+import org.springframework.boot.micrometer.tracing.autoconfigure.TracingProperties;
 import org.springframework.boot.micrometer.tracing.autoconfigure.TracingProperties.Propagation.PropagationType;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
@@ -64,7 +67,7 @@
  */
 @AutoConfiguration(before = { MicrometerTracingAutoConfiguration.class, NoopTracerAutoConfiguration.class })
 @ConditionalOnClass({ Tracer.class, BraveTracer.class })
-@EnableConfigurationProperties(TracingProperties.class)
+@EnableConfigurationProperties({ TracingProperties.class, BraveTracingProperties.class })
 @Import({ BravePropagationConfigurations.PropagationWithoutBaggage.class,
 		BravePropagationConfigurations.PropagationWithBaggage.class,
 		BravePropagationConfigurations.NoPropagation.class })
@@ -77,8 +80,11 @@ public final class BraveAutoConfiguration {
 
 	private final TracingProperties tracingProperties;
 
-	BraveAutoConfiguration(TracingProperties tracingProperties) {
+	private final BraveTracingProperties braveTracingProperties;
+
+	BraveAutoConfiguration(TracingProperties tracingProperties, BraveTracingProperties braveTracingProperties) {
 		this.tracingProperties = tracingProperties;
+		this.braveTracingProperties = braveTracingProperties;
 	}
 
 	@Bean
@@ -95,28 +101,28 @@ CompositeSpanHandler compositeSpanHandler(ObjectProvider<SpanExportingPredicate>
 	Tracing braveTracing(Environment environment, List<SpanHandler> spanHandlers,
 			List<TracingCustomizer> tracingCustomizers, CurrentTraceContext currentTraceContext,
 			Factory propagationFactory, Sampler sampler) {
-		if (this.tracingProperties.getBrave().isSpanJoiningSupported()) {
+		if (this.braveTracingProperties.isSpanJoiningSupported()) {
 			if (this.tracingProperties.getPropagation().getType() != null
 					&& this.tracingProperties.getPropagation().getType().contains(PropagationType.W3C)) {
 				throw new IncompatibleConfigurationException("management.tracing.propagation.type",
-						"management.tracing.brave.span-joining-supported");
+						"management.brave.tracing.span-joining-supported");
 			}
 			if (this.tracingProperties.getPropagation().getType() == null
 					&& this.tracingProperties.getPropagation().getProduce().contains(PropagationType.W3C)) {
 				throw new IncompatibleConfigurationException("management.tracing.propagation.produce",
-						"management.tracing.brave.span-joining-supported");
+						"management.brave.tracing.span-joining-supported");
 			}
 			if (this.tracingProperties.getPropagation().getType() == null
 					&& this.tracingProperties.getPropagation().getConsume().contains(PropagationType.W3C)) {
 				throw new IncompatibleConfigurationException("management.tracing.propagation.consume",
-						"management.tracing.brave.span-joining-supported");
+						"management.brave.tracing.span-joining-supported");
 			}
 		}
 		String applicationName = environment.getProperty("spring.application.name", DEFAULT_APPLICATION_NAME);
 		Builder builder = Tracing.newBuilder()
 			.currentTraceContext(currentTraceContext)
 			.traceId128Bit(true)
-			.supportsJoin(this.tracingProperties.getBrave().isSpanJoiningSupported())
+			.supportsJoin(this.braveTracingProperties.isSpanJoiningSupported())
 			.propagationFactory(propagationFactory)
 			.sampler(sampler)
 			.localServiceName(applicationName);

module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/BravePropagationConfigurations.java renamed to module/spring-boot-micrometer-tracing-brave/src/main/java/org/springframework/boot/micrometer/tracing/brave/autoconfigure/BravePropagationConfigurations.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.micrometer.tracing.autoconfigure;
+package org.springframework.boot.micrometer.tracing.brave.autoconfigure;
 
 import java.util.List;
 
@@ -37,6 +37,8 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBooleanProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.micrometer.tracing.autoconfigure.ConditionalOnEnabledTracingExport;
+import org.springframework.boot.micrometer.tracing.autoconfigure.TracingProperties;
 import org.springframework.boot.micrometer.tracing.autoconfigure.TracingProperties.Baggage.Correlation;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

module/spring-boot-micrometer-tracing-brave/src/main/java/org/springframework/boot/micrometer/tracing/brave/autoconfigure/BraveTracingProperties.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.micrometer.tracing.brave.autoconfigure;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * Configuration properties for tracing with Brave.
+ *
+ * @author Moritz Halbritter
+ * @since 4.0.0
+ */
+@ConfigurationProperties("management.brave.tracing")
+public class BraveTracingProperties {
+
+	/**
+	 * Whether the propagation type and tracing backend support sharing the span ID
+	 * between client and server spans. Requires B3 propagation and a compatible backend.
+	 */
+	private boolean spanJoiningSupported = false;
+
+	public boolean isSpanJoiningSupported() {
+		return this.spanJoiningSupported;
+	}
+
+	public void setSpanJoiningSupported(boolean spanJoiningSupported) {
+		this.spanJoiningSupported = spanJoiningSupported;
+	}
+
+}

module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/CompositePropagationFactory.java renamed to module/spring-boot-micrometer-tracing-brave/src/main/java/org/springframework/boot/micrometer/tracing/brave/autoconfigure/CompositePropagationFactory.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.micrometer.tracing.autoconfigure;
+package org.springframework.boot.micrometer.tracing.brave.autoconfigure;
 
 import java.util.Collection;
 import java.util.Collections;
@@ -30,6 +30,7 @@
 import io.micrometer.tracing.brave.bridge.W3CPropagation;
 import org.jspecify.annotations.Nullable;
 
+import org.springframework.boot.micrometer.tracing.autoconfigure.TracingProperties;
 import org.springframework.boot.micrometer.tracing.autoconfigure.TracingProperties.Propagation.PropagationType;
 
 /**
@@ -118,11 +119,19 @@ static CompositePropagationFactory create(TracingProperties.Propagation properti
 	static CompositePropagationFactory create(TracingProperties.Propagation properties,
 			@Nullable BaggageManager baggageManager, @Nullable LocalBaggageFields localFields) {
 		PropagationFactoryMapper mapper = new PropagationFactoryMapper(baggageManager, localFields);
-		List<Factory> injectors = properties.getEffectiveProducedTypes().stream().map(mapper::map).toList();
-		List<Factory> extractors = properties.getEffectiveConsumedTypes().stream().map(mapper::map).toList();
+		List<Factory> injectors = getEffectiveProducedTypes(properties).stream().map(mapper::map).toList();
+		List<Factory> extractors = getEffectiveConsumedTypes(properties).stream().map(mapper::map).toList();
 		return new CompositePropagationFactory(injectors, extractors);
 	}
 
+	private static List<PropagationType> getEffectiveConsumedTypes(TracingProperties.Propagation properties) {
+		return (properties.getType() != null) ? properties.getType() : properties.getConsume();
+	}
+
+	private static List<PropagationType> getEffectiveProducedTypes(TracingProperties.Propagation properties) {
+		return (properties.getType() != null) ? properties.getType() : properties.getProduce();
+	}
+
 	/**
 	 * Mapper used to create a {@link brave.propagation.Propagation.Factory Propagation
 	 * factory} from a {@link PropagationType}.