Introduce properties for configuring the OpenTelemetry BatchSpanProcessor

This commit adds the following properties to allow customization
of the BatchSpanProcessor:

- management.tracing.opentelemetry.batch-span-processor.export-unsampled-spans
- management.tracing.opentelemetry.batch-span-processor.exporter-timeout
- management.tracing.opentelemetry.batch-span-processor.max-export-batch-size
- management.tracing.opentelemetry.batch-span-processor.max-queue-size
- management.tracing.opentelemetry.batch-span-processor.schedule-delay

Default values were taken from BatchSpanProcessorBuilder.

Signed-off-by: Dmytro Nosan <dimanosan@gmail.com>

Author: nosan

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

@@ -119,9 +119,17 @@ SpanProcessors spanProcessors(ObjectProvider<SpanProcessor> spanProcessors) {
 	BatchSpanProcessor otelSpanProcessor(SpanExporters spanExporters,
 			ObjectProvider<SpanExportingPredicate> spanExportingPredicates, ObjectProvider<SpanReporter> spanReporters,
 			ObjectProvider<SpanFilter> spanFilters, ObjectProvider<MeterProvider> meterProvider) {
-		BatchSpanProcessorBuilder builder = BatchSpanProcessor
-			.builder(new CompositeSpanExporter(spanExporters.list(), spanExportingPredicates.orderedStream().toList(),
-					spanReporters.orderedStream().toList(), spanFilters.orderedStream().toList()));
+		TracingProperties.OpenTelemetry.BatchSpanProcessor properties = this.tracingProperties.getOpentelemetry()
+			.getBatchSpanProcessor();
+		CompositeSpanExporter spanExporter = new CompositeSpanExporter(spanExporters.list(),
+				spanExportingPredicates.orderedStream().toList(), spanReporters.orderedStream().toList(),
+				spanFilters.orderedStream().toList());
+		BatchSpanProcessorBuilder builder = BatchSpanProcessor.builder(spanExporter)
+			.setExporterTimeout(properties.getExporterTimeout())
+			.setExportUnsampledSpans(properties.isExportUnsampledSpans())
+			.setMaxExportBatchSize(properties.getMaxExportBatchSize())
+			.setMaxQueueSize(properties.getMaxQueueSize())
+			.setScheduleDelay(properties.getScheduleDelay());
 		meterProvider.ifAvailable(builder::setMeterProvider);
 		return builder.build();
 	}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2024 the original author or authors.
+ * Copyright 2012-2025 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.
@@ -16,6 +16,7 @@
 
 package org.springframework.boot.actuate.autoconfigure.tracing;
 
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -51,6 +52,11 @@ public class TracingProperties {
 	 */
 	private final Brave brave = new Brave();
 
+	/**
+	 * OpenTelemetry configuration.
+	 */
+	private final OpenTelemetry opentelemetry = new OpenTelemetry();
+
 	public Sampling getSampling() {
 		return this.sampling;
 	}
@@ -67,6 +73,10 @@ public Brave getBrave() {
 		return this.brave;
 	}
 
+	public OpenTelemetry getOpentelemetry() {
+		return this.opentelemetry;
+	}
+
 	public static class Sampling {
 
 		/**
@@ -293,4 +303,87 @@ public void setSpanJoiningSupported(boolean spanJoiningSupported) {
 
 	}
 
+	public static class OpenTelemetry {
+
+		/**
+		 * Batch Span Processor configuration.
+		 */
+		private final BatchSpanProcessor batchSpanProcessor = new BatchSpanProcessor();
+
+		public BatchSpanProcessor getBatchSpanProcessor() {
+			return this.batchSpanProcessor;
+		}
+
+		public static class BatchSpanProcessor {
+
+			/**
+			 * Whether unsampled spans should be exported.
+			 */
+			private boolean exportUnsampledSpans;
+
+			/**
+			 * Maximum time an export will be allowed to run before being cancelled.
+			 */
+			private Duration exporterTimeout = Duration.ofSeconds(30);
+
+			/**
+			 * Maximum batch size for each export. This must be less than or equal to
+			 * maxQueueSize.
+			 */
+			private int maxExportBatchSize = 512;
+
+			/**
+			 * Maximum number of Spans that are kept in the queue before start dropping.
+			 */
+			private int maxQueueSize = 2048;
+
+			/**
+			 * The delay interval between two consecutive exports.
+			 */
+			private Duration scheduleDelay = Duration.ofSeconds(5);
+
+			public boolean isExportUnsampledSpans() {
+				return this.exportUnsampledSpans;
+			}
+
+			public void setExportUnsampledSpans(boolean exportUnsampledSpans) {
+				this.exportUnsampledSpans = exportUnsampledSpans;
+			}
+
+			public Duration getExporterTimeout() {
+				return this.exporterTimeout;
+			}
+
+			public void setExporterTimeout(Duration exporterTimeout) {
+				this.exporterTimeout = exporterTimeout;
+			}
+
+			public int getMaxExportBatchSize() {
+				return this.maxExportBatchSize;
+			}
+
+			public void setMaxExportBatchSize(int maxExportBatchSize) {
+				this.maxExportBatchSize = maxExportBatchSize;
+			}
+
+			public int getMaxQueueSize() {
+				return this.maxQueueSize;
+			}
+
+			public void setMaxQueueSize(int maxQueueSize) {
+				this.maxQueueSize = maxQueueSize;
+			}
+
+			public Duration getScheduleDelay() {
+				return this.scheduleDelay;
+			}
+
+			public void setScheduleDelay(Duration scheduleDelay) {
+				this.scheduleDelay = scheduleDelay;
+			}
+
+		}
+
+	}
+
 }

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

@@ -70,6 +70,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.annotation.Order;
+import org.springframework.test.util.ReflectionTestUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.fail;
@@ -324,6 +325,44 @@ void shouldDisablePropagationIfTracingIsDisabled() {
 		});
 	}
 
+	@Test
+	void batchSpanProcessorShouldBeConfiguredWithCustomProperties() {
+		this.contextRunner
+			.withPropertyValues("management.tracing.opentelemetry.batch-span-processor.exporter-timeout=45s",
+					"management.tracing.opentelemetry.batch-span-processor.export-unsampled-spans=true",
+					"management.tracing.opentelemetry.batch-span-processor.max-export-batch-size=256",
+					"management.tracing.opentelemetry.batch-span-processor.max-queue-size=4096",
+					"management.tracing.opentelemetry.batch-span-processor.schedule-delay=15s")
+			.run((context) -> {
+				assertThat(context).hasSingleBean(BatchSpanProcessor.class);
+				BatchSpanProcessor batchSpanProcessor = context.getBean(BatchSpanProcessor.class);
+				assertThat(batchSpanProcessor).hasFieldOrPropertyWithValue("exportUnsampledSpans", true)
+					.extracting("worker")
+					.hasFieldOrPropertyWithValue("exporterTimeoutNanos", Duration.ofSeconds(45).toNanos())
+					.hasFieldOrPropertyWithValue("maxExportBatchSize", 256)
+					.hasFieldOrPropertyWithValue("scheduleDelayNanos", Duration.ofSeconds(15).toNanos())
+					.extracting("queue")
+					.satisfies((queue) -> assertThat(ReflectionTestUtils.<Integer>invokeMethod(queue, "capacity"))
+						.isEqualTo(4096));
+			});
+	}
+
+	@Test
+	void batchSpanProcessorShouldBeConfiguredWithDefaultProperties() {
+		this.contextRunner.run((context) -> {
+			assertThat(context).hasSingleBean(BatchSpanProcessor.class);
+			BatchSpanProcessor batchSpanProcessor = context.getBean(BatchSpanProcessor.class);
+			assertThat(batchSpanProcessor).hasFieldOrPropertyWithValue("exportUnsampledSpans", false)
+				.extracting("worker")
+				.hasFieldOrPropertyWithValue("exporterTimeoutNanos", Duration.ofSeconds(30).toNanos())
+				.hasFieldOrPropertyWithValue("maxExportBatchSize", 512)
+				.hasFieldOrPropertyWithValue("scheduleDelayNanos", Duration.ofSeconds(5).toNanos())
+				.extracting("queue")
+				.satisfies((queue) -> assertThat(ReflectionTestUtils.<Integer>invokeMethod(queue, "capacity"))
+					.isEqualTo(2048));
+		});
+	}
+
 	@Test // gh-41439
 	@ForkedClassPath
 	void shouldPublishEventsWhenContextStorageIsInitializedEarly() {