Add distinct properties for consumed and produced propagation types

Author: mhalbritter

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/BraveAutoConfiguration.java

@@ -167,8 +167,8 @@ static class BraveNoBaggageConfiguration {
 		@Bean
 		@ConditionalOnMissingBean
 		Factory propagationFactory(TracingProperties properties) {
-			return CompositePropagationFactory.create(properties.getPropagation().getType(),
-					properties.getPropagation().getConsumeTypes());
+			return CompositePropagationFactory.create(properties.getPropagation().getEffectiveProduceTypes(),
+					properties.getPropagation().getEffectiveConsumeTypes());
 		}
 
 	}
@@ -188,8 +188,8 @@ static class BraveBaggageConfiguration {
 		BaggagePropagation.FactoryBuilder propagationFactoryBuilder(
 				ObjectProvider<BaggagePropagationCustomizer> baggagePropagationCustomizers) {
 			Factory delegate = CompositePropagationFactory.create(BRAVE_BAGGAGE_MANAGER,
-					this.tracingProperties.getPropagation().getType(),
-					this.tracingProperties.getPropagation().getConsumeTypes());
+					this.tracingProperties.getPropagation().getEffectiveProduceTypes(),
+					this.tracingProperties.getPropagation().getEffectiveConsumeTypes());
 			FactoryBuilder builder = BaggagePropagation.newFactoryBuilder(delegate);
 			baggagePropagationCustomizers.orderedStream().forEach((customizer) -> customizer.customize(builder));
 			return builder;

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/OpenTelemetryAutoConfiguration.java

@@ -188,8 +188,8 @@ TextMapPropagator textMapPropagatorWithBaggage(OtelCurrentTraceContext otelCurre
 			BaggageTextMapPropagator baggagePropagator = new BaggageTextMapPropagator(remoteFields,
 					new OtelBaggageManager(otelCurrentTraceContext, remoteFields, Collections.emptyList()));
 			return CompositeTextMapPropagator.create(baggagePropagator,
-					this.tracingProperties.getPropagation().getType(),
-					this.tracingProperties.getPropagation().getConsumeTypes());
+					this.tracingProperties.getPropagation().getEffectiveProduceTypes(),
+					this.tracingProperties.getPropagation().getEffectiveConsumeTypes());
 		}
 
 		@Bean
@@ -208,8 +208,8 @@ static class NoBaggageConfiguration {
 
 		@Bean
 		TextMapPropagator textMapPropagator(TracingProperties properties) {
-			return CompositeTextMapPropagator.create(properties.getPropagation().getType(),
-					properties.getPropagation().getConsumeTypes());
+			return CompositeTextMapPropagator.create(properties.getPropagation().getEffectiveProduceTypes(),
+					properties.getPropagation().getEffectiveConsumeTypes());
 		}
 
 	}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/TracingProperties.java

@@ -165,29 +165,68 @@ public void setFields(List<String> fields) {
 
 	public static class Propagation {
 
+		/**
+		 * Tracing context propagation types produced and consumed by the application.
+		 * Setting this property overrides the more fine-grained propagation type
+		 * properties.
+		 */
+		private List<PropagationType> type;
+
 		/**
 		 * Tracing context propagation types produced by the application.
 		 */
-		private List<PropagationType> type = List.of(PropagationType.W3C);
+		private List<PropagationType> produceTypes = List.of(PropagationType.W3C);
 
 		/**
 		 * Tracing context propagation types consumed by the application.
 		 */
 		private List<PropagationType> consumeTypes = List.of(PropagationType.values());
 
+		public void setType(List<PropagationType> type) {
+			this.type = type;
+		}
+
+		public void setProduceTypes(List<PropagationType> produceTypes) {
+			this.produceTypes = produceTypes;
+		}
+
+		public void setConsumeTypes(List<PropagationType> consumeTypes) {
+			this.consumeTypes = consumeTypes;
+		}
+
 		public List<PropagationType> getType() {
 			return this.type;
 		}
 
-		public void setType(List<PropagationType> type) {
-			this.type = type;
+		public List<PropagationType> getProduceTypes() {
+			return this.produceTypes;
 		}
 
-		void setConsumeTypes(List<PropagationType> consumeTypes) {
-			this.consumeTypes = consumeTypes;
+		public List<PropagationType> getConsumeTypes() {
+			return this.consumeTypes;
+		}
+
+		/**
+		 * Returns the effective context propagation types produced by the application.
+		 * This will be {@link #getType()} if set or {@link #getProduceTypes()} otherwise.
+		 * @return the effective context propagation types produced by the application
+		 */
+		List<PropagationType> getEffectiveProduceTypes() {
+			if (this.type != null) {
+				return this.type;
+			}
+			return this.produceTypes;
 		}
 
-		List<PropagationType> getConsumeTypes() {
+		/**
+		 * Returns the effective context propagation types consumed by the application.
+		 * This will be {@link #getType()} if set or {@link #getConsumeTypes()} otherwise.
+		 * @return the effective context propagation types consumed by the application
+		 */
+		List<PropagationType> getEffectiveConsumeTypes() {
+			if (this.type != null) {
+				return this.type;
+			}
 			return this.consumeTypes;
 		}
 
@@ -197,7 +236,7 @@ List<PropagationType> getConsumeTypes() {
 		enum PropagationType {
 
 			/**
-			 * <a href="https://www.w3.org/TR/trace-context/">W3C propagation.</a>
+			 * <a href="https://www.w3.org/TR/trace-context/">W3C</a> propagation.
 			 */
 			W3C,
 

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

@@ -2166,8 +2166,18 @@
       }
     },
     {
-      "name": "management.tracing.propagation.type",
-      "defaultValue": "W3C"
+      "name": "management.tracing.propagation.consume-types",
+      "defaultValue": [
+        "W3C",
+        "B3",
+        "B3_MULTI"
+      ]
+    },
+    {
+      "name": "management.tracing.propagation.produce-types",
+      "defaultValue": [
+        "W3C"
+      ]
     }
   ],
   "hints": [

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/TracingPropertiesTests.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2012-2023 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.actuate.autoconfigure.tracing;
+
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link TracingProperties}.
+ *
+ * @author Moritz Halbritter
+ */
+class TracingPropertiesTests {
+
+	@Test
+	void propagationTypeShouldOverrideProduceTypes() {
+		TracingProperties.Propagation propagation = new TracingProperties.Propagation();
+		propagation.setProduceTypes(List.of(TracingProperties.Propagation.PropagationType.W3C));
+		propagation.setType(List.of(TracingProperties.Propagation.PropagationType.B3));
+		assertThat(propagation.getEffectiveProduceTypes())
+			.containsExactly(TracingProperties.Propagation.PropagationType.B3);
+	}
+
+	@Test
+	void propagationTypeShouldOverrideConsumeTypes() {
+		TracingProperties.Propagation propagation = new TracingProperties.Propagation();
+		propagation.setConsumeTypes(List.of(TracingProperties.Propagation.PropagationType.W3C));
+		propagation.setType(List.of(TracingProperties.Propagation.PropagationType.B3));
+		assertThat(propagation.getEffectiveConsumeTypes())
+			.containsExactly(TracingProperties.Propagation.PropagationType.B3);
+	}
+
+	@Test
+	void getEffectiveConsumeTypes() {
+		TracingProperties.Propagation propagation = new TracingProperties.Propagation();
+		propagation.setConsumeTypes(List.of(TracingProperties.Propagation.PropagationType.W3C));
+		assertThat(propagation.getEffectiveConsumeTypes())
+			.containsExactly(TracingProperties.Propagation.PropagationType.W3C);
+	}
+
+	@Test
+	void getEffectiveProduceTypes() {
+		TracingProperties.Propagation propagation = new TracingProperties.Propagation();
+		propagation.setProduceTypes(List.of(TracingProperties.Propagation.PropagationType.W3C));
+		assertThat(propagation.getEffectiveProduceTypes())
+			.containsExactly(TracingProperties.Propagation.PropagationType.W3C);
+	}
+
+}