Refactor tracing annotation and export condition

- Rename @ConditionalOnEnabledTracing to @ConditionalOnEnabledTracingExport
- Rename global property from management.tracing.enabled to management.tracing.export.enabled
- Update additional-spring-configuration-metadata.json accordingly
- Rename OnEnabledTracingCondition to OnEnabledTracingExportCondition

Signed-off-by: Maziyar Bahramian <maziyar.bahramian@gmail.com>

Author: maziyarbahramian

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

@@ -233,7 +233,7 @@ Regardless of your classpath, tracing components which are reporting data are no
 
 If you need those components as part of an integration test, annotate the test with javadoc:org.springframework.boot.test.autoconfigure.actuate.observability.AutoConfigureObservability[format=annotation].
 
-If you have created your own reporting components (e.g. a custom javadoc:io.opentelemetry.sdk.trace.export.SpanExporter[] or `brave.handler.SpanHandler`) and you don't want them to be active in tests, you can use the javadoc:org.springframework.boot.micrometer.tracing.autoconfigure.ConditionalOnEnabledTracing[format=annotation] annotation to disable them.
+If you have created your own reporting components (e.g. a custom javadoc:io.opentelemetry.sdk.trace.export.SpanExporter[] or `brave.handler.SpanHandler`) and you don't want them to be active in tests, you can use the javadoc:org.springframework.boot.micrometer.tracing.autoconfigure.ConditionalOnEnabledTracingExport[format=annotation] annotation to disable them.
 
 If you annotate xref:testing/spring-boot-applications.adoc#testing.spring-boot-applications.autoconfigured-tests[a sliced test] with javadoc:org.springframework.boot.test.autoconfigure.actuate.observability.AutoConfigureObservability[format=annotation], it auto-configures a no-op javadoc:io.micrometer.tracing.Tracer[].
 Data exporting in sliced tests is not supported with the javadoc:org.springframework.boot.test.autoconfigure.actuate.observability.AutoConfigureObservability[format=annotation] annotation.

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

@@ -58,7 +58,7 @@ static class PropagationWithoutBaggage {
 
 		@Bean
 		@ConditionalOnMissingBean(Factory.class)
-		@ConditionalOnEnabledTracing
+		@ConditionalOnEnabledTracingExport
 		CompositePropagationFactory propagationFactory(TracingProperties properties) {
 			return CompositePropagationFactory.create(properties.getPropagation());
 		}
@@ -127,7 +127,7 @@ BaggagePropagationCustomizer remoteFieldsBaggagePropagationCustomizer() {
 
 		@Bean
 		@ConditionalOnMissingBean
-		@ConditionalOnEnabledTracing
+		@ConditionalOnEnabledTracingExport
 		Factory propagationFactory(BaggagePropagation.FactoryBuilder factoryBuilder) {
 			return factoryBuilder.build();
 		}

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

@@ -26,8 +26,8 @@
 
 /**
  * {@link Conditional @Conditional} that checks whether tracing is enabled. It matches if
- * the value of the {@code management.tracing.enabled} property is {@code true} or if it
- * is not configured. If the {@link #value() tracing exporter name} is set, the
+ * the value of the {@code management.tracing.export.enabled} property is {@code true} or
+ * if it is not configured. If the {@link #value() tracing exporter name} is set, the
  * {@code management.<name>.tracing.export.enabled} property can be used to control the
  * behavior for the specific tracing exporter. In that case, the exporter specific
  * property takes precedence over the global property.
@@ -38,8 +38,8 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.TYPE, ElementType.METHOD })
 @Documented
-@Conditional(OnEnabledTracingCondition.class)
-public @interface ConditionalOnEnabledTracing {
+@Conditional(OnEnabledTracingExportCondition.class)
+public @interface ConditionalOnEnabledTracingExport {
 
 	/**
 	 * Name of the tracing exporter.

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

@@ -31,7 +31,7 @@
  * {@link EnvironmentPostProcessor} to add a {@link PropertySource} to support log
  * correlation IDs when Micrometer Tracing is present. Adds support for the
  * {@value LoggingSystem#EXPECT_CORRELATION_ID_PROPERTY} property by delegating to
- * {@code management.tracing.enabled}.
+ * {@code management.tracing.export.enabled}.
  *
  * @author Jonatan Ivanov
  * @author Phillip Webb
@@ -67,7 +67,7 @@ public String[] getPropertyNames() {
 		@Override
 		public @Nullable Object getProperty(String name) {
 			if (name.equals(LoggingSystem.EXPECT_CORRELATION_ID_PROPERTY)) {
-				return this.environment.getProperty("management.tracing.enabled", Boolean.class, Boolean.TRUE);
+				return this.environment.getProperty("management.tracing.export.enabled", Boolean.class, Boolean.TRUE);
 			}
 			return null;
 		}

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

@@ -31,11 +31,12 @@
  * {@link SpringBootCondition} to check whether tracing is enabled.
  *
  * @author Moritz Halbritter
- * @see ConditionalOnEnabledTracing
+ * @see ConditionalOnEnabledTracingExport
  */
-class OnEnabledTracingCondition extends SpringBootCondition {
+class OnEnabledTracingExportCondition extends SpringBootCondition {
 
-	private static final String GLOBAL_PROPERTY = "management.tracing.enabled";
+	/// management.tracing.enabled
+	private static final String GLOBAL_PROPERTY = "management.tracing.export.enabled";
 
 	private static final String EXPORTER_PROPERTY = "management.%s.tracing.export.enabled";
 
@@ -47,23 +48,23 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM
 				.getProperty(EXPORTER_PROPERTY.formatted(tracingExporter), Boolean.class);
 			if (exporterTracingEnabled != null) {
 				return new ConditionOutcome(exporterTracingEnabled,
-						ConditionMessage.forCondition(ConditionalOnEnabledTracing.class)
+						ConditionMessage.forCondition(ConditionalOnEnabledTracingExport.class)
 							.because(EXPORTER_PROPERTY.formatted(tracingExporter) + " is " + exporterTracingEnabled));
 			}
 		}
 		Boolean globalTracingEnabled = context.getEnvironment().getProperty(GLOBAL_PROPERTY, Boolean.class);
 		if (globalTracingEnabled != null) {
 			return new ConditionOutcome(globalTracingEnabled,
-					ConditionMessage.forCondition(ConditionalOnEnabledTracing.class)
+					ConditionMessage.forCondition(ConditionalOnEnabledTracingExport.class)
 						.because(GLOBAL_PROPERTY + " is " + globalTracingEnabled));
 		}
-		return ConditionOutcome.match(ConditionMessage.forCondition(ConditionalOnEnabledTracing.class)
+		return ConditionOutcome.match(ConditionMessage.forCondition(ConditionalOnEnabledTracingExport.class)
 			.because("tracing is enabled by default"));
 	}
 
 	private static @Nullable String getExporterName(AnnotatedTypeMetadata metadata) {
 		Map<String, @Nullable Object> attributes = metadata
-			.getAnnotationAttributes(ConditionalOnEnabledTracing.class.getName());
+			.getAnnotationAttributes(ConditionalOnEnabledTracingExport.class.getName());
 		if (attributes == null) {
 			return null;
 		}

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

@@ -47,7 +47,7 @@ class OpenTelemetryPropagationConfigurations {
 	static class PropagationWithoutBaggage {
 
 		@Bean
-		@ConditionalOnEnabledTracing
+		@ConditionalOnEnabledTracingExport
 		TextMapPropagator textMapPropagator(TracingProperties properties) {
 			return CompositeTextMapPropagator.create(properties.getPropagation(), null);
 		}
@@ -69,7 +69,7 @@ static class PropagationWithBaggage {
 		}
 
 		@Bean
-		@ConditionalOnEnabledTracing
+		@ConditionalOnEnabledTracingExport
 		TextMapPropagator textMapPropagatorWithBaggage(OtelCurrentTraceContext otelCurrentTraceContext) {
 			List<String> remoteFields = this.tracingProperties.getBaggage().getRemoteFields();
 			List<String> tagFields = this.tracingProperties.getBaggage().getTagFields();

module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/otlp/OtlpTracingConfigurations.java

@@ -28,7 +28,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.boot.micrometer.tracing.autoconfigure.ConditionalOnEnabledTracing;
+import org.springframework.boot.micrometer.tracing.autoconfigure.ConditionalOnEnabledTracingExport;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.util.Assert;
@@ -79,7 +79,7 @@ public String getUrl(Transport transport) {
 	@Configuration(proxyBeanMethods = false)
 	@ConditionalOnMissingBean({ OtlpGrpcSpanExporter.class, OtlpHttpSpanExporter.class })
 	@ConditionalOnBean(OtlpTracingConnectionDetails.class)
-	@ConditionalOnEnabledTracing("otlp")
+	@ConditionalOnEnabledTracingExport("otlp")
 	static class Exporters {
 
 		@Bean

module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/zipkin/ZipkinTracingAutoConfiguration.java

@@ -34,7 +34,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.micrometer.tracing.autoconfigure.ConditionalOnEnabledTracing;
+import org.springframework.boot.micrometer.tracing.autoconfigure.ConditionalOnEnabledTracingExport;
 import org.springframework.boot.micrometer.tracing.autoconfigure.zipkin.ZipkinTracingAutoConfiguration.BraveConfiguration;
 import org.springframework.boot.micrometer.tracing.autoconfigure.zipkin.ZipkinTracingAutoConfiguration.OpenTelemetryConfiguration;
 import org.springframework.context.annotation.Bean;
@@ -71,7 +71,7 @@ BytesEncoder<MutableSpan> mutableSpanBytesEncoder(Encoding encoding,
 		@Bean
 		@ConditionalOnMissingBean
 		@ConditionalOnBean(BytesMessageSender.class)
-		@ConditionalOnEnabledTracing("zipkin")
+		@ConditionalOnEnabledTracingExport("zipkin")
 		AsyncZipkinSpanHandler asyncZipkinSpanHandler(BytesMessageSender sender,
 				BytesEncoder<MutableSpan> mutableSpanBytesEncoder) {
 			return AsyncZipkinSpanHandler.newBuilder(sender).build(mutableSpanBytesEncoder);
@@ -93,7 +93,7 @@ BytesEncoder<Span> spanBytesEncoder(Encoding encoding) {
 		@Bean
 		@ConditionalOnMissingBean
 		@ConditionalOnBean(BytesMessageSender.class)
-		@ConditionalOnEnabledTracing("zipkin")
+		@ConditionalOnEnabledTracingExport("zipkin")
 		ZipkinSpanExporter zipkinSpanExporter(BytesMessageSender sender, BytesEncoder<Span> spanBytesEncoder) {
 			return ZipkinSpanExporter.builder().setSender(sender).setEncoder(spanBytesEncoder).build();
 		}

module/spring-boot-micrometer-tracing/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -7,7 +7,7 @@
       "description": "Whether auto-configuration of tracing is enabled to export OTLP traces."
     },
     {
-      "name": "management.tracing.enabled",
+      "name": "management.tracing.export.enabled",
       "type": "java.lang.Boolean",
       "description": "Whether auto-configuration of tracing is enabled to export and propagate traces.",
       "defaultValue": true

module/spring-boot-micrometer-tracing/src/test/java/org/springframework/boot/micrometer/tracing/autoconfigure/BraveAutoConfigurationTests.java

@@ -350,7 +350,7 @@ void compositeSpanHandlerUsesFilterPredicateAndReportersInOrder() {
 
 	@Test
 	void shouldDisablePropagationIfTracingIsDisabled() {
-		this.contextRunner.withPropertyValues("management.tracing.enabled=false").run((context) -> {
+		this.contextRunner.withPropertyValues("management.tracing.export.enabled=false").run((context) -> {
 			assertThat(context).hasSingleBean(Factory.class);
 			Factory factory = context.getBean(Factory.class);
 			Propagation<String> propagation = factory.get();