Implement JDK HttpClient based Zipkin sender

Closes gh-39545

Author: mhalbritter

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 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.
@@ -74,7 +74,7 @@ protected void postSpans(URI endpoint, byte[] body) throws IOException {
 	 * @param headers headers for the POST request
 	 * @param body list of possibly gzipped, encoded spans.
 	 */
-	abstract void postSpans(URI endpoint, HttpHeaders headers, byte[] body);
+	abstract void postSpans(URI endpoint, HttpHeaders headers, byte[] body) throws IOException;
 
 	HttpHeaders getDefaultHeaders() {
 		HttpHeaders headers = new HttpHeaders();

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinConfigurations.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,6 +16,9 @@
 
 package org.springframework.boot.actuate.autoconfigure.tracing.zipkin;
 
+import java.net.http.HttpClient;
+import java.net.http.HttpClient.Builder;
+
 import brave.Tag;
 import brave.Tags;
 import brave.handler.MutableSpan;
@@ -53,7 +56,7 @@ class ZipkinConfigurations {
 
 	@Configuration(proxyBeanMethods = false)
 	@Import({ UrlConnectionSenderConfiguration.class, WebClientSenderConfiguration.class,
-			RestTemplateSenderConfiguration.class })
+			RestTemplateSenderConfiguration.class, HttpClientSenderConfiguration.class })
 	static class SenderConfiguration {
 
 	}
@@ -90,6 +93,7 @@ static class RestTemplateSenderConfiguration {
 
 		@Bean
 		@ConditionalOnMissingBean(BytesMessageSender.class)
+		@SuppressWarnings("removal")
 		ZipkinRestTemplateSender restTemplateSender(ZipkinProperties properties, Encoding encoding,
 				ObjectProvider<ZipkinRestTemplateBuilderCustomizer> customizers,
 				ObjectProvider<ZipkinConnectionDetails> connectionDetailsProvider,
@@ -106,6 +110,7 @@ ZipkinRestTemplateSender restTemplateSender(ZipkinProperties properties, Encodin
 					restTemplateBuilder.build());
 		}
 
+		@SuppressWarnings("removal")
 		private RestTemplateBuilder applyCustomizers(RestTemplateBuilder restTemplateBuilder,
 				ObjectProvider<ZipkinRestTemplateBuilderCustomizer> customizers) {
 			Iterable<ZipkinRestTemplateBuilderCustomizer> orderedCustomizers = () -> customizers.orderedStream()
@@ -126,6 +131,7 @@ static class WebClientSenderConfiguration {
 
 		@Bean
 		@ConditionalOnMissingBean(BytesMessageSender.class)
+		@SuppressWarnings("removal")
 		ZipkinWebClientSender webClientSender(ZipkinProperties properties, Encoding encoding,
 				ObjectProvider<ZipkinWebClientBuilderCustomizer> customizers,
 				ObjectProvider<ZipkinConnectionDetails> connectionDetailsProvider,
@@ -142,6 +148,29 @@ ZipkinWebClientSender webClientSender(ZipkinProperties properties, Encoding enco
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(HttpClient.class)
+	@EnableConfigurationProperties(ZipkinProperties.class)
+	static class HttpClientSenderConfiguration {
+
+		@Bean
+		@ConditionalOnMissingBean(BytesMessageSender.class)
+		ZipkinHttpClientSender httpClientSender(ZipkinProperties properties, Encoding encoding,
+				ObjectProvider<ZipkinHttpClientBuilderCustomizer> customizers,
+				ObjectProvider<ZipkinConnectionDetails> connectionDetailsProvider,
+				ObjectProvider<HttpEndpointSupplier.Factory> endpointSupplierFactoryProvider) {
+			ZipkinConnectionDetails connectionDetails = connectionDetailsProvider
+				.getIfAvailable(() -> new PropertiesZipkinConnectionDetails(properties));
+			HttpEndpointSupplier.Factory endpointSupplierFactory = endpointSupplierFactoryProvider
+				.getIfAvailable(HttpEndpointSuppliers::constantFactory);
+			Builder httpClientBuilder = HttpClient.newBuilder().connectTimeout(properties.getConnectTimeout());
+			customizers.orderedStream().forEach((customizer) -> customizer.customize(httpClientBuilder));
+			return new ZipkinHttpClientSender(encoding, endpointSupplierFactory, connectionDetails.getSpanEndpoint(),
+					httpClientBuilder.build(), properties.getReadTimeout());
+		}
+
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	@ConditionalOnClass(AsyncZipkinSpanHandler.class)
 	static class BraveConfiguration {

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

@@ -0,0 +1,37 @@
+/*
+ * 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.
+ * 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.zipkin;
+
+import java.net.http.HttpClient;
+
+/**
+ * Callback interface that can be implemented by beans wishing to customize the
+ * {@link HttpClient.Builder} used to send spans to Zipkin.
+ *
+ * @author Moritz Halbritter
+ * @since 3.3.0
+ */
+@FunctionalInterface
+public interface ZipkinHttpClientBuilderCustomizer {
+
+	/**
+	 * Customize the http client builder.
+	 * @param httpClient the http client builder to customize
+	 */
+	void customize(HttpClient.Builder httpClient);
+
+}

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

@@ -0,0 +1,71 @@
+/*
+ * 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.
+ * 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.zipkin;
+
+import java.io.IOException;
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpRequest.BodyPublishers;
+import java.net.http.HttpRequest.Builder;
+import java.net.http.HttpResponse;
+import java.net.http.HttpResponse.BodyHandlers;
+import java.time.Duration;
+
+import zipkin2.reporter.Encoding;
+import zipkin2.reporter.HttpEndpointSupplier.Factory;
+
+import org.springframework.http.HttpHeaders;
+
+/**
+ * A {@link HttpSender} which uses the JDK {@link HttpClient} for HTTP communication.
+ *
+ * @author Moritz Halbritter
+ */
+class ZipkinHttpClientSender extends HttpSender {
+
+	private final HttpClient httpClient;
+
+	private final Duration readTimeout;
+
+	ZipkinHttpClientSender(Encoding encoding, Factory endpointSupplierFactory, String endpoint, HttpClient httpClient,
+			Duration readTimeout) {
+		super(encoding, endpointSupplierFactory, endpoint);
+		this.httpClient = httpClient;
+		this.readTimeout = readTimeout;
+	}
+
+	@Override
+	void postSpans(URI endpoint, HttpHeaders headers, byte[] body) throws IOException {
+		Builder request = HttpRequest.newBuilder()
+			.POST(BodyPublishers.ofByteArray(body))
+			.uri(endpoint)
+			.timeout(this.readTimeout);
+		headers.forEach((key, values) -> values.forEach((value) -> request.header(key, value)));
+		try {
+			HttpResponse<Void> response = this.httpClient.send(request.build(), BodyHandlers.discarding());
+			if (response.statusCode() / 100 != 2) {
+				throw new IOException("Expected HTTP status 2xx, got %d".formatted(response.statusCode()));
+			}
+		}
+		catch (InterruptedException ex) {
+			Thread.currentThread().interrupt();
+			throw new IOException("Got interrupted while sending spans", ex);
+		}
+	}
+
+}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 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.
@@ -24,8 +24,11 @@
  *
  * @author Marcin Grzejszczak
  * @since 3.0.0
+ * @deprecated since 3.3.0 for removal in 3.5.0 in favor of
+ * {@link ZipkinHttpClientBuilderCustomizer}
  */
 @FunctionalInterface
+@Deprecated(since = "3.3.0", forRemoval = true)
 public interface ZipkinRestTemplateBuilderCustomizer {
 
 	/**

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 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.
@@ -32,6 +32,7 @@
  * @author Moritz Halbritter
  * @author Stefan Bratanov
  */
+@Deprecated(since = "3.3.0", forRemoval = true)
 class ZipkinRestTemplateSender extends HttpSender {
 
 	private final RestTemplate restTemplate;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 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.
@@ -25,8 +25,11 @@
  *
  * @author Marcin Grzejszczak
  * @since 3.0.0
+ * @deprecated since 3.3.0 for removal in 3.5.0 in favor of
+ * {@link ZipkinHttpClientBuilderCustomizer}
  */
 @FunctionalInterface
+@Deprecated(since = "3.3.0", forRemoval = true)
 public interface ZipkinWebClientBuilderCustomizer {
 
 	/**

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinWebClientSender.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.
@@ -31,6 +31,7 @@
  * @author Stefan Bratanov
  * @author Moritz Halbritter
  */
+@Deprecated(since = "3.3.0", forRemoval = true)
 class ZipkinWebClientSender extends HttpSender {
 
 	private final WebClient webClient;

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

@@ -50,6 +50,7 @@
  *
  * @author Moritz Halbritter
  */
+@SuppressWarnings("removal")
 class ZipkinConfigurationsSenderConfigurationTests {
 
 	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
@@ -70,6 +71,20 @@ void shouldSupplyBeans() {
 		});
 	}
 
+	@Test
+	void shouldUseHttpClientIfUrlSenderIsNotAvailable() {
+		this.contextRunner.withUserConfiguration(HttpClientConfiguration.class)
+			.withClassLoader(new FilteredClassLoader("zipkin2.reporter.urlconnection", "org.springframework.web.client",
+					"org.springframework.web.reactive.function.client"))
+			.run((context) -> {
+				assertThat(context).doesNotHaveBean(URLConnectionSender.class);
+				assertThat(context).hasSingleBean(BytesMessageSender.class);
+				assertThat(context).hasSingleBean(ZipkinHttpClientSender.class);
+				then(context.getBean(ZipkinHttpClientBuilderCustomizer.class)).should()
+					.customize(ArgumentMatchers.any());
+			});
+	}
+
 	@Test
 	void shouldPreferWebClientSenderIfWebApplicationIsReactiveAndUrlSenderIsNotAvailable() {
 		this.reactiveContextRunner.withUserConfiguration(RestTemplateConfiguration.class, WebClientConfiguration.class)
@@ -220,6 +235,16 @@ ZipkinWebClientBuilderCustomizer webClientBuilder() {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	private static final class HttpClientConfiguration {
+
+		@Bean
+		ZipkinHttpClientBuilderCustomizer httpClientBuilderCustomizer() {
+			return mock(ZipkinHttpClientBuilderCustomizer.class);
+		}
+
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	private static final class CustomConfiguration {