Polish "Support Otlp Tracing's GRPC port from service connections"

See spring-projectsgh-41333

Author: wilkinsona

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/otlp/OtlpProperties.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.
@@ -99,20 +99,6 @@ public void setHeaders(Map<String, String> headers) {
 		this.headers = headers;
 	}
 
-	public enum Transport {
-
-		/**
-		 * HTTP transport.
-		 */
-		HTTP,
-
-		/**
-		 * gRPC transport.
-		 */
-		GRPC
-
-	}
-
 	public enum Compression {
 
 		/**

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

@@ -24,7 +24,6 @@
 import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder;
 
 import org.springframework.boot.actuate.autoconfigure.tracing.ConditionalOnEnabledTracing;
-import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpProperties.Transport;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@@ -66,7 +65,7 @@ public String getUrl() {
 			}
 
 			@Override
-			public String getGrpcEndpoint() {
+			public String getEndpoint(Transport transport) {
 				return this.properties.getEndpoint();
 			}
 
@@ -86,7 +85,7 @@ static class Exporters {
 		OtlpHttpSpanExporter otlpHttpSpanExporter(OtlpProperties properties,
 				OtlpTracingConnectionDetails connectionDetails) {
 			OtlpHttpSpanExporterBuilder builder = OtlpHttpSpanExporter.builder()
-				.setEndpoint(resolveEndpoint(properties.getTransport(), connectionDetails))
+				.setEndpoint(connectionDetails.getEndpoint(properties.getTransport()))
 				.setTimeout(properties.getTimeout())
 				.setCompression(properties.getCompression().name().toLowerCase());
 			for (Entry<String, String> header : properties.getHeaders().entrySet()) {
@@ -100,7 +99,7 @@ OtlpHttpSpanExporter otlpHttpSpanExporter(OtlpProperties properties,
 		OtlpGrpcSpanExporter otlpGrpcSpanExporter(OtlpProperties properties,
 				OtlpTracingConnectionDetails connectionDetails) {
 			OtlpGrpcSpanExporterBuilder builder = OtlpGrpcSpanExporter.builder()
-				.setEndpoint(resolveEndpoint(properties.getTransport(), connectionDetails))
+				.setEndpoint(connectionDetails.getEndpoint(properties.getTransport()))
 				.setTimeout(properties.getTimeout())
 				.setCompression(properties.getCompression().name().toLowerCase());
 			for (Entry<String, String> header : properties.getHeaders().entrySet()) {
@@ -109,11 +108,6 @@ OtlpGrpcSpanExporter otlpGrpcSpanExporter(OtlpProperties properties,
 			return builder.build();
 		}
 
-		private static String resolveEndpoint(OtlpProperties.Transport transport,
-				OtlpTracingConnectionDetails connectionDetails) {
-			return (transport == Transport.HTTP) ? connectionDetails.getUrl() : connectionDetails.getGrpcEndpoint();
-		}
-
 	}
 
 }

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

@@ -27,13 +27,23 @@
 public interface OtlpTracingConnectionDetails extends ConnectionDetails {
 
 	/**
-	 * Address to where tracing will be published.
+	 * Address to which tracing will be published using an {@link Transport#HTTP HTTP
+	 * transport}.
 	 * @return the address to where tracing will be published
+	 * @deprecated since 3.4.0 for removal in 3.6.0 in favor of
+	 * {@link #getEndpoint(Transport)}
 	 */
+	@Deprecated(since = "3.4.0", forRemoval = true)
 	String getUrl();
 
-	default String getGrpcEndpoint() {
-		return "http://localhost:4317/v1/traces";
+	/**
+	 * Endpoint to which tracing will be published for the given {@code transport}.
+	 * @param transport the transport
+	 * @return the endpoint to which tracing will be published
+	 * @since 3.4.0
+	 */
+	default String getEndpoint(Transport transport) {
+		return getUrl();
 	}
 
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/otlp/Transport.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.otlp;
+
+/**
+ * The transport used when communicating with an OpenTelemetry service.
+ *
+ * @author Andy Wilkinson
+ * @since 3.4.0
+ */
+public enum Transport {
+
+	/**
+	 * HTTP transport.
+	 */
+	HTTP,
+
+	/**
+	 * gRPC transport.
+	 */
+	GRPC
+
+}

spring-boot-project/spring-boot-docker-compose/src/dockerTest/java/org/springframework/boot/docker/compose/service/connection/otlp/OpenTelemetryTracingDockerComposeConnectionDetailsFactoryIntegrationTests.java

@@ -17,6 +17,7 @@
 package org.springframework.boot.docker.compose.service.connection.otlp;
 
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
+import org.springframework.boot.actuate.autoconfigure.tracing.otlp.Transport;
 import org.springframework.boot.docker.compose.service.connection.test.DockerComposeTest;
 import org.springframework.boot.testsupport.container.TestImage;
 
@@ -32,8 +33,11 @@ class OpenTelemetryTracingDockerComposeConnectionDetailsFactoryIntegrationTests
 
 	@DockerComposeTest(composeFile = "otlp-compose.yaml", image = TestImage.OPENTELEMETRY)
 	void runCreatesConnectionDetails(OtlpTracingConnectionDetails connectionDetails) {
-		assertThat(connectionDetails.getGrpcEndpoint()).startsWith("http://").endsWith("/v1/traces");
-		assertThat(connectionDetails.getUrl()).startsWith("http://").endsWith("/v1/traces");
+		String grpcEndpoint = connectionDetails.getEndpoint(Transport.GRPC);
+		String httpEndpoint = connectionDetails.getEndpoint(Transport.HTTP);
+		assertThat(grpcEndpoint).startsWith("http://").endsWith("/v1/traces");
+		assertThat(httpEndpoint).startsWith("http://").endsWith("/v1/traces");
+		assertThat(grpcEndpoint).isNotEqualTo(httpEndpoint);
 	}
 
 }

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/otlp/OpenTelemetryTracingDockerComposeConnectionDetailsFactory.java

@@ -17,6 +17,7 @@
 package org.springframework.boot.docker.compose.service.connection.otlp;
 
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
+import org.springframework.boot.actuate.autoconfigure.tracing.otlp.Transport;
 import org.springframework.boot.docker.compose.core.RunningService;
 import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory;
 import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionSource;
@@ -51,23 +52,28 @@ private static final class OpenTelemetryTracingDockerComposeConnectionDetails ex
 
 		private final int grpcPort;
 
-		private final int httPort;
+		private final int httpPort;
 
 		private OpenTelemetryTracingDockerComposeConnectionDetails(RunningService source) {
 			super(source);
 			this.host = source.host();
 			this.grpcPort = source.ports().get(OTLP_GRPC_PORT);
-			this.httPort = source.ports().get(OTLP_HTTP_PORT);
+			this.httpPort = source.ports().get(OTLP_HTTP_PORT);
 		}
 
 		@Override
+		@Deprecated(since = "3.4.0", forRemoval = true)
 		public String getUrl() {
-			return "http://%s:%d/v1/traces".formatted(this.host, this.httPort);
+			return getEndpoint(Transport.HTTP);
 		}
 
 		@Override
-		public String getGrpcEndpoint() {
-			return "http://%s:%d/v1/traces".formatted(this.host, this.grpcPort);
+		public String getEndpoint(Transport transport) {
+			int port = switch (transport) {
+				case HTTP -> this.httpPort;
+				case GRPC -> this.grpcPort;
+			};
+			return "http://%s:%d/v1/traces".formatted(this.host, port);
 		}
 
 	}

spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/otlp/OpenTelemetryTracingContainerConnectionDetailsFactoryIntegrationTests.java

@@ -24,6 +24,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
+import org.springframework.boot.actuate.autoconfigure.tracing.otlp.Transport;
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
 import org.springframework.boot.testsupport.container.TestImage;
@@ -51,9 +52,9 @@ class OpenTelemetryTracingContainerConnectionDetailsFactoryIntegrationTests {
 
 	@Test
 	void connectionCanBeMadeToOpenTelemetryContainer() {
-		assertThat(this.connectionDetails.getGrpcEndpoint())
+		assertThat(this.connectionDetails.getEndpoint(Transport.GRPC))
 			.isEqualTo("http://" + container.getHost() + ":" + container.getMappedPort(4317) + "/v1/traces");
-		assertThat(this.connectionDetails.getUrl())
+		assertThat(this.connectionDetails.getEndpoint(Transport.HTTP))
 			.isEqualTo("http://" + container.getHost() + ":" + container.getMappedPort(4318) + "/v1/traces");
 	}
 

spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/otlp/OpenTelemetryTracingContainerConnectionDetailsFactory.java

@@ -20,6 +20,7 @@
 import org.testcontainers.containers.GenericContainer;
 
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
+import org.springframework.boot.actuate.autoconfigure.tracing.otlp.Transport;
 import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
 import org.springframework.boot.testcontainers.service.connection.ContainerConnectionSource;
 import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
@@ -58,15 +59,18 @@ private OpenTelemetryTracingContainerConnectionDetails(ContainerConnectionSource
 		}
 
 		@Override
+		@Deprecated(since = "3.4.0", forRemoval = true)
 		public String getUrl() {
-			return "http://%s:%d/v1/traces".formatted(getContainer().getHost(),
-					getContainer().getMappedPort(OTLP_HTTP_PORT));
+			return getEndpoint(Transport.HTTP);
 		}
 
 		@Override
-		public String getGrpcEndpoint() {
-			return "http://%s:%d/v1/traces".formatted(getContainer().getHost(),
-					getContainer().getMappedPort(OTLP_GRPC_PORT));
+		public String getEndpoint(Transport transport) {
+			int port = switch (transport) {
+				case GRPC -> OTLP_GRPC_PORT;
+				case HTTP -> OTLP_HTTP_PORT;
+			};
+			return "http://%s:%d/v1/traces".formatted(getContainer().getHost(), getContainer().getMappedPort(port));
 		}
 
 	}