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

See gh-41333

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

@@ -30,6 +30,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.util.Assert;
 
 /**
  * Configurations imported by {@link OtlpAutoConfiguration}.
@@ -61,12 +62,10 @@ class OtlpTracingConfigurations {
 			}
 
 			@Override
-			public String getUrl() {
+			public String getUrl(Transport transport) {
-				return this.properties.getEndpoint();
+				Assert.state(transport == this.properties.getTransport(),
-			}
+						"Requested transport %s doesn't match configured transport %s".formatted(transport,
-
+								this.properties.getTransport()));
-			@Override
-			public String getGrpcEndpoint() {
 				return this.properties.getEndpoint();
 			}
 
@@ -86,7 +85,7 @@ class OtlpTracingConfigurations {
 		OtlpHttpSpanExporter otlpHttpSpanExporter(OtlpProperties properties,
 				OtlpTracingConnectionDetails connectionDetails) {
 			OtlpHttpSpanExporterBuilder builder = OtlpHttpSpanExporter.builder()
-				.setEndpoint(resolveEndpoint(properties.getTransport(), connectionDetails))
+				.setEndpoint(connectionDetails.getUrl(Transport.HTTP))
 				.setTimeout(properties.getTimeout())
 				.setCompression(properties.getCompression().name().toLowerCase());
 			for (Entry<String, String> header : properties.getHeaders().entrySet()) {
@@ -100,7 +99,7 @@ class OtlpTracingConfigurations {
 		OtlpGrpcSpanExporter otlpGrpcSpanExporter(OtlpProperties properties,
 				OtlpTracingConnectionDetails connectionDetails) {
 			OtlpGrpcSpanExporterBuilder builder = OtlpGrpcSpanExporter.builder()
-				.setEndpoint(resolveEndpoint(properties.getTransport(), connectionDetails))
+				.setEndpoint(connectionDetails.getUrl(Transport.GRPC))
 				.setTimeout(properties.getTimeout())
 				.setCompression(properties.getCompression().name().toLowerCase());
 			for (Entry<String, String> header : properties.getHeaders().entrySet()) {
@@ -109,10 +108,6 @@ class OtlpTracingConfigurations {
 			return builder.build();
 		}
 
-		private static String resolveEndpoint(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

@@ -16,12 +16,14 @@
 
 package org.springframework.boot.actuate.autoconfigure.tracing.otlp;
 
+import org.springframework.boot.actuate.autoconfigure.opentelemetry.otlp.Transport;
 import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
 
 /**
  * Details required to establish a connection to an OpenTelemetry service.
  *
  * @author Eddú Meléndez
+ * @author Moritz Halbritter
  * @since 3.2.0
  */
 public interface OtlpTracingConnectionDetails extends ConnectionDetails {
@@ -29,11 +31,19 @@ public interface OtlpTracingConnectionDetails extends ConnectionDetails {
 	/**
 	 * Address to where tracing will be published.
 	 * @return the address to where tracing will be published
+	 * @deprecated since 3.4.0 for removal in 3.6.0 in favor of {@link #getUrl(Transport)}
 	 */
-	String getUrl();
+	@Deprecated(since = "3.4.0", forRemoval = true)
-
+	default String getUrl() {
-	default String getGrpcEndpoint() {
+		return getUrl(Transport.HTTP);
-		return "http://localhost:4317/v1/traces";
 	}
 
+	/**
+	 * Address to where tracing will be published.
+	 * @param transport the transport to use
+	 * @return the address to where tracing will be published
+	 * @since 3.4.0
+	 */
+	String getUrl(Transport transport);
+
 }

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

@@ -172,7 +172,7 @@ class OtlpAutoConfigurationTests {
 
 		@Bean
 		OtlpTracingConnectionDetails otlpTracingConnectionDetails() {
-			return () -> "http://localhost:12345/v1/traces";
+			return (transport) -> "http://localhost:12345/v1/traces";
 		}
 
 	}

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

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.docker.compose.service.connection.otlp;
 
+import org.springframework.boot.actuate.autoconfigure.opentelemetry.otlp.Transport;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
 import org.springframework.boot.docker.compose.service.connection.test.DockerComposeTest;
 import org.springframework.boot.testsupport.container.TestImage;
@@ -32,7 +33,8 @@ class GrafanaOpenTelemetryTracingDockerComposeConnectionDetailsFactoryIntegratio
 
 	@DockerComposeTest(composeFile = "otlp-compose.yaml", image = TestImage.GRAFANA_OTEL_LGTM)
 	void runCreatesConnectionDetails(OtlpTracingConnectionDetails connectionDetails) {
-		assertThat(connectionDetails.getUrl()).startsWith("http://").endsWith("/v1/traces");
+		assertThat(connectionDetails.getUrl(Transport.HTTP)).startsWith("http://").endsWith("/v1/traces");
+		assertThat(connectionDetails.getUrl(Transport.GRPC)).startsWith("http://").endsWith("/v1/traces");
 	}
 
 }

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

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.docker.compose.service.connection.otlp;
 
+import org.springframework.boot.actuate.autoconfigure.opentelemetry.otlp.Transport;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
 import org.springframework.boot.docker.compose.service.connection.test.DockerComposeTest;
 import org.springframework.boot.testsupport.container.TestImage;
@@ -32,8 +33,8 @@ 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(Transport.HTTP)).startsWith("http://").endsWith("/v1/traces");
-		assertThat(connectionDetails.getUrl()).startsWith("http://").endsWith("/v1/traces");
+		assertThat(connectionDetails.getUrl(Transport.GRPC)).startsWith("http://").endsWith("/v1/traces");
 	}
 
 }

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

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.docker.compose.service.connection.otlp;
 
+import org.springframework.boot.actuate.autoconfigure.opentelemetry.otlp.Transport;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
 import org.springframework.boot.docker.compose.core.RunningService;
 import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory;
@@ -26,6 +27,7 @@ import org.springframework.boot.docker.compose.service.connection.DockerComposeC
  * {@link OtlpTracingConnectionDetails} for an OTLP service.
  *
  * @author Eddú Meléndez
+ * @author Moritz Halbritter
  */
 class OpenTelemetryTracingDockerComposeConnectionDetailsFactory
 		extends DockerComposeConnectionDetailsFactory<OtlpTracingConnectionDetails> {
@@ -64,13 +66,12 @@ class OpenTelemetryTracingDockerComposeConnectionDetailsFactory
 		}
 
 		@Override
-		public String getUrl() {
+		public String getUrl(Transport transport) {
-			return "http://%s:%d/v1/traces".formatted(this.host, this.httPort);
+			int port = switch (transport) {
-		}
+				case HTTP -> this.httPort;
-
+				case GRPC -> this.grpcPort;
-		@Override
+			};
-		public String getGrpcEndpoint() {
+			return "http://%s:%d/v1/traces".formatted(this.host, port);
-			return "http://%s:%d/v1/traces".formatted(this.host, this.grpcPort);
 		}
 
 	}

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

@@ -22,6 +22,7 @@ import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.autoconfigure.opentelemetry.otlp.Transport;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
@@ -50,7 +51,10 @@ class GrafanaOpenTelemetryTracingContainerConnectionDetailsFactoryIntegrationTes
 
 	@Test
 	void connectionCanBeMadeToOpenTelemetryContainer() {
-		assertThat(this.connectionDetails.getUrl()).isEqualTo("%s/v1/traces".formatted(container.getOtlpHttpUrl()));
+		assertThat(this.connectionDetails.getUrl(Transport.HTTP))
+			.isEqualTo("%s/v1/traces".formatted(container.getOtlpHttpUrl()));
+		assertThat(this.connectionDetails.getUrl(Transport.GRPC))
+			.isEqualTo("%s/v1/traces".formatted(container.getOtlpGrpcUrl()));
 	}
 
 	@Configuration(proxyBeanMethods = false)

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

@@ -22,6 +22,7 @@ import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.autoconfigure.opentelemetry.otlp.Transport;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
@@ -51,10 +52,10 @@ class OpenTelemetryTracingContainerConnectionDetailsFactoryIntegrationTests {
 
 	@Test
 	void connectionCanBeMadeToOpenTelemetryContainer() {
-		assertThat(this.connectionDetails.getGrpcEndpoint())
+		assertThat(this.connectionDetails.getUrl(Transport.HTTP))
-			.isEqualTo("http://" + container.getHost() + ":" + container.getMappedPort(4317) + "/v1/traces");
-		assertThat(this.connectionDetails.getUrl())
 			.isEqualTo("http://" + container.getHost() + ":" + container.getMappedPort(4318) + "/v1/traces");
+		assertThat(this.connectionDetails.getUrl(Transport.GRPC))
+			.isEqualTo("http://" + container.getHost() + ":" + container.getMappedPort(4317) + "/v1/traces");
 	}
 
 	@Configuration(proxyBeanMethods = false)

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

@@ -18,6 +18,7 @@ package org.springframework.boot.testcontainers.service.connection.otlp;
 
 import org.testcontainers.grafana.LgtmStackContainer;
 
+import org.springframework.boot.actuate.autoconfigure.opentelemetry.otlp.Transport;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
 import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
 import org.springframework.boot.testcontainers.service.connection.ContainerConnectionSource;
@@ -52,8 +53,12 @@ class GrafanaOpenTelemetryTracingContainerConnectionDetailsFactory
 		}
 
 		@Override
-		public String getUrl() {
+		public String getUrl(Transport transport) {
-			return "%s/v1/traces".formatted(getContainer().getOtlpHttpUrl());
+			String url = switch (transport) {
+				case HTTP -> getContainer().getOtlpHttpUrl();
+				case GRPC -> getContainer().getOtlpGrpcUrl();
+			};
+			return "%s/v1/traces".formatted(url);
 		}
 
 	}

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

@@ -19,6 +19,7 @@ package org.springframework.boot.testcontainers.service.connection.otlp;
 import org.testcontainers.containers.Container;
 import org.testcontainers.containers.GenericContainer;
 
+import org.springframework.boot.actuate.autoconfigure.opentelemetry.otlp.Transport;
 import org.springframework.boot.actuate.autoconfigure.tracing.otlp.OtlpTracingConnectionDetails;
 import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
 import org.springframework.boot.testcontainers.service.connection.ContainerConnectionSource;
@@ -58,15 +59,12 @@ class OpenTelemetryTracingContainerConnectionDetailsFactory
 		}
 
 		@Override
-		public String getUrl() {
+		public String getUrl(Transport transport) {
-			return "http://%s:%d/v1/traces".formatted(getContainer().getHost(),
+			int port = switch (transport) {
-					getContainer().getMappedPort(OTLP_HTTP_PORT));
+				case HTTP -> OTLP_HTTP_PORT;
-		}
+				case GRPC -> OTLP_GRPC_PORT;
-
+			};
-		@Override
+			return "http://%s:%d/v1/traces".formatted(getContainer().getHost(), getContainer().getMappedPort(port));
-		public String getGrpcEndpoint() {
-			return "http://%s:%d/v1/traces".formatted(getContainer().getHost(),
-					getContainer().getMappedPort(OTLP_GRPC_PORT));
 		}
 
 	}