Polish "Migrate to Brave 6 and Zipkin Reporter 3"

See gh-39049

Author: mhalbritter

Diff for: spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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,8 +16,10 @@
 
 package org.springframework.boot.actuate.autoconfigure.tracing.zipkin;
 
-import zipkin2.reporter.BytesMessageSender;
+import zipkin2.Span;
+import zipkin2.reporter.BytesEncoder;
 import zipkin2.reporter.Encoding;
+import zipkin2.reporter.SpanBytesEncoder;
 
 import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinConfigurations.BraveConfiguration;
 import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinConfigurations.OpenTelemetryConfiguration;
@@ -41,7 +43,7 @@
  * @since 3.0.0
  */
 @AutoConfiguration(after = RestTemplateAutoConfiguration.class)
-@ConditionalOnClass(BytesMessageSender.class)
+@ConditionalOnClass(Encoding.class)
 @Import({ SenderConfiguration.class, BraveConfiguration.class, OpenTelemetryConfiguration.class })
 @EnableConfigurationProperties(ZipkinProperties.class)
 public class ZipkinAutoConfiguration {
@@ -54,8 +56,17 @@ PropertiesZipkinConnectionDetails zipkinConnectionDetails(ZipkinProperties prope
 
 	@Bean
 	@ConditionalOnMissingBean
-	public Encoding encoding(ZipkinProperties properties) {
-		return properties.getEncoding();
+	Encoding encoding(ZipkinProperties properties) {
+		return switch (properties.getEncoding()) {
+			case JSON -> Encoding.JSON;
+			case PROTO3 -> Encoding.PROTO3;
+		};
+	}
+
+	@Bean
+	@ConditionalOnMissingBean(value = Span.class, parameterizedContainer = BytesEncoder.class)
+	BytesEncoder<Span> zipkinSpanEncoder(Encoding encoding) {
+		return SpanBytesEncoder.forEncoding(encoding);
 	}
 
 }

Diff for: spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinConfigurations.java

@@ -26,7 +26,6 @@
 import zipkin2.reporter.Encoding;
 import zipkin2.reporter.HttpEndpointSupplier;
 import zipkin2.reporter.HttpEndpointSuppliers;
-import zipkin2.reporter.SpanBytesEncoder;
 import zipkin2.reporter.brave.AsyncZipkinSpanHandler;
 import zipkin2.reporter.brave.MutableSpanBytesEncoder;
 import zipkin2.reporter.urlconnection.URLConnectionSender;
@@ -170,12 +169,6 @@ AsyncZipkinSpanHandler asyncZipkinSpanHandler(BytesMessageSender sender,
 	@ConditionalOnClass(ZipkinSpanExporter.class)
 	static class OpenTelemetryConfiguration {
 
-		@Bean
-		@ConditionalOnMissingBean(value = Span.class, parameterizedContainer = BytesEncoder.class)
-		BytesEncoder<Span> zipkinSpanEncoder(Encoding encoding) {
-			return SpanBytesEncoder.forEncoding(encoding);
-		}
-
 		@Bean
 		@ConditionalOnMissingBean
 		@ConditionalOnBean(BytesMessageSender.class)

Diff for: spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinProperties.java

@@ -18,8 +18,6 @@
 
 import java.time.Duration;
 
-import zipkin2.reporter.Encoding;
-
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
@@ -83,4 +81,20 @@ public void setReadTimeout(Duration readTimeout) {
 		this.readTimeout = readTimeout;
 	}
 
+	/**
+	 * Zipkin message encoding.
+	 */
+	public enum Encoding {
+
+		/**
+		 * JSON.
+		 */
+		JSON,
+		/**
+		 * Protocol Buffers v3.
+		 */
+		PROTO3
+
+	}
+
 }

Diff for: spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinAutoConfigurationTests.java

@@ -40,7 +40,8 @@ class ZipkinAutoConfigurationTests {
 	@Test
 	void shouldSupplyBeans() {
 		this.contextRunner.run((context) -> assertThat(context).hasSingleBean(Encoding.class)
-			.hasSingleBean(PropertiesZipkinConnectionDetails.class));
+			.hasSingleBean(PropertiesZipkinConnectionDetails.class)
+			.hasBean("zipkinSpanEncoder"));
 	}
 
 	@Test

Diff for: spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinConfigurationsOpenTelemetryConfigurationTests.java

@@ -31,6 +31,7 @@
 import org.springframework.context.annotation.Configuration;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
 
 /**
  * Tests for {@link OpenTelemetryConfiguration}.
@@ -48,6 +49,7 @@ class ZipkinConfigurationsOpenTelemetryConfigurationTests {
 	@Test
 	void shouldSupplyBeans() {
 		this.contextRunner.withUserConfiguration(SenderConfiguration.class)
+			.withBean(BytesEncoder.class, () -> mock(BytesEncoder.class))
 			.run((context) -> assertThat(context).hasSingleBean(ZipkinSpanExporter.class));
 	}
 

Diff for: spring-boot-project/spring-boot-dependencies/build.gradle

@@ -112,7 +112,7 @@ bom {
 	library("Zipkin Reporter", "3.3.0") {
 		group("io.zipkin.reporter2") {
 			imports = [
-					"zipkin-reporter-bom"
+				"zipkin-reporter-bom"
 			]
 		}
 	}