Add service connection from OpenTelemetry Collector

See gh-35082

Author: eddumelendez

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpConnectionDetails.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2012-2023 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.metrics.export.otlp;
+
+import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
+
+/**
+ * Details required to establish a connection to a OpenTelemetry Collector service.
+ *
+ * @author Eddú Meléndez
+ * @since 3.1.0
+ */
+public interface OtlpConnectionDetails extends ConnectionDetails {
+
+	String getUrl();
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpMetricsExportAutoConfiguration.java

@@ -50,11 +50,17 @@
 @EnableConfigurationProperties({ OtlpProperties.class, OpenTelemetryProperties.class })
 public class OtlpMetricsExportAutoConfiguration {
 
+	@Bean
+	@ConditionalOnMissingBean(OtlpConnectionDetails.class)
+	public OtlpConnectionDetails otlpConnectionDetails(OtlpProperties properties) {
+		return new PropertiesOtlpConnectionDetails(properties);
+	}
+
 	@Bean
 	@ConditionalOnMissingBean
 	OtlpConfig otlpConfig(OtlpProperties properties, OpenTelemetryProperties openTelemetryProperties,
-			Environment environment) {
-		return new OtlpPropertiesConfigAdapter(properties, openTelemetryProperties, environment);
+			OtlpConnectionDetails connectionDetails, Environment environment) {
+		return new OtlpPropertiesConfigAdapter(properties, openTelemetryProperties, connectionDetails, environment);
 	}
 
 	@Bean
@@ -63,4 +69,22 @@ public OtlpMeterRegistry otlpMeterRegistry(OtlpConfig otlpConfig, Clock clock) {
 		return new OtlpMeterRegistry(otlpConfig, clock);
 	}
 
+	/**
+	 * Adapts {@link OtlpProperties} to {@link OtlpConnectionDetails}.
+	 */
+	static class PropertiesOtlpConnectionDetails implements OtlpConnectionDetails {
+
+		private final OtlpProperties properties;
+
+		PropertiesOtlpConnectionDetails(OtlpProperties properties) {
+			this.properties = properties;
+		}
+
+		@Override
+		public String getUrl() {
+			return this.properties.getUrl();
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpPropertiesConfigAdapter.java

@@ -45,11 +45,14 @@ class OtlpPropertiesConfigAdapter extends StepRegistryPropertiesConfigAdapter<Ot
 
 	private final OpenTelemetryProperties openTelemetryProperties;
 
+	private final OtlpConnectionDetails connectionDetails;
+
 	private final Environment environment;
 
 	OtlpPropertiesConfigAdapter(OtlpProperties properties, OpenTelemetryProperties openTelemetryProperties,
-			Environment environment) {
+			OtlpConnectionDetails connectionDetails, Environment environment) {
 		super(properties);
+		this.connectionDetails = connectionDetails;
 		this.openTelemetryProperties = openTelemetryProperties;
 		this.environment = environment;
 	}
@@ -61,7 +64,7 @@ public String prefix() {
 
 	@Override
 	public String url() {
-		return get(OtlpProperties::getUrl, OtlpConfig.super::url);
+		return get((properties) -> this.connectionDetails.getUrl(), OtlpConfig.super::url);
 	}
 
 	@Override

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

@@ -28,6 +28,7 @@
 import org.springframework.boot.actuate.autoconfigure.tracing.ConditionalOnEnabledTracing;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@@ -47,21 +48,30 @@
  *
  * @author Jonatan Ivanov
  * @author Moritz Halbritter
+ * @author Eddú Meléndez
  * @since 3.1.0
  */
 @AutoConfiguration
 @ConditionalOnClass({ OtelTracer.class, SdkTracerProvider.class, OpenTelemetry.class, OtlpHttpSpanExporter.class })
 @EnableConfigurationProperties(OtlpProperties.class)
 public class OtlpAutoConfiguration {
 
+	@Bean
+	@ConditionalOnMissingBean(OtlpTracingConnectionDetails.class)
+	@ConditionalOnProperty(prefix = "management.otlp.tracing", name = "endpoint")
+	OtlpTracingConnectionDetails otlpTracingConnectionDetails(OtlpProperties properties) {
+		return new PropertiesOtlpTracingConnectionDetails(properties);
+	}
+
 	@Bean
 	@ConditionalOnMissingBean(value = OtlpHttpSpanExporter.class,
 			type = "io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter")
-	@ConditionalOnProperty(prefix = "management.otlp.tracing", name = "endpoint")
+	@ConditionalOnBean(OtlpTracingConnectionDetails.class)
 	@ConditionalOnEnabledTracing
-	OtlpHttpSpanExporter otlpHttpSpanExporter(OtlpProperties properties) {
+	OtlpHttpSpanExporter otlpHttpSpanExporter(OtlpProperties properties,
+			OtlpTracingConnectionDetails connectionDetails) {
 		OtlpHttpSpanExporterBuilder builder = OtlpHttpSpanExporter.builder()
-			.setEndpoint(properties.getEndpoint())
+			.setEndpoint(connectionDetails.getEndpoint())
 			.setTimeout(properties.getTimeout())
 			.setCompression(properties.getCompression().name().toLowerCase());
 		for (Entry<String, String> header : properties.getHeaders().entrySet()) {
@@ -70,4 +80,22 @@ OtlpHttpSpanExporter otlpHttpSpanExporter(OtlpProperties properties) {
 		return builder.build();
 	}
 
+	/**
+	 * Adapts {@link OtlpProperties} to {@link OtlpTracingConnectionDetails}.
+	 */
+	static class PropertiesOtlpTracingConnectionDetails implements OtlpTracingConnectionDetails {
+
+		private final OtlpProperties properties;
+
+		PropertiesOtlpTracingConnectionDetails(OtlpProperties properties) {
+			this.properties = properties;
+		}
+
+		@Override
+		public String getEndpoint() {
+			return this.properties.getEndpoint();
+		}
+
+	}
+
 }

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

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2012-2023 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;
+
+import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
+
+/**
+ * Details required to establish a connection to a OpenTelemetry service.
+ *
+ * @author Eddú Meléndez
+ * @since 3.1.0
+ */
+public interface OtlpTracingConnectionDetails extends ConnectionDetails {
+
+	String getEndpoint();
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpMetricsExportAutoConfigurationTests.java

@@ -83,6 +83,24 @@ void allowsRegistryToBeCustomized() {
 				.hasBean("customRegistry"));
 	}
 
+	@Test
+	void definesPropertiesBasedConnectionDetailsByDefault() {
+		this.contextRunner.withUserConfiguration(BaseConfiguration.class)
+			.run((context) -> assertThat(context)
+				.hasSingleBean(OtlpMetricsExportAutoConfiguration.PropertiesOtlpConnectionDetails.class));
+	}
+
+	@Test
+	void testConnectionFactoryWithOverridesWhenUsingCustomConnectionDetails() {
+		this.contextRunner.withUserConfiguration(BaseConfiguration.class, ConnectionDetailsConfiguration.class)
+			.run((context) -> {
+				assertThat(context).hasSingleBean(OtlpConnectionDetails.class)
+					.doesNotHaveBean(OtlpMetricsExportAutoConfiguration.PropertiesOtlpConnectionDetails.class);
+				OtlpConfig config = context.getBean(OtlpConfig.class);
+				assertThat(config.url()).isEqualTo("http://localhost:12345/v1/metrics");
+			});
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	static class BaseConfiguration {
 
@@ -115,4 +133,14 @@ OtlpMeterRegistry customRegistry(OtlpConfig config, Clock clock) {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	static class ConnectionDetailsConfiguration {
+
+		@Bean
+		OtlpConnectionDetails otlpConnectionDetails() {
+			return () -> "http://localhost:12345/v1/metrics";
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpPropertiesConfigAdapterTests.java

@@ -24,6 +24,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import org.springframework.boot.actuate.autoconfigure.metrics.export.otlp.OtlpMetricsExportAutoConfiguration.PropertiesOtlpConnectionDetails;
 import org.springframework.boot.actuate.autoconfigure.opentelemetry.OpenTelemetryProperties;
 import org.springframework.mock.env.MockEnvironment;
 
@@ -44,11 +45,14 @@ class OtlpPropertiesConfigAdapterTests {
 
 	private MockEnvironment environment;
 
+	private OtlpConnectionDetails connectionDetails;
+
 	@BeforeEach
 	void setUp() {
 		this.properties = new OtlpProperties();
 		this.openTelemetryProperties = new OpenTelemetryProperties();
 		this.environment = new MockEnvironment();
+		this.connectionDetails = new PropertiesOtlpConnectionDetails(this.properties);
 	}
 
 	@Test
@@ -136,7 +140,8 @@ void shouldUseDefaultApplicationNameIfApplicationNameIsNotSet() {
 	}
 
 	private OtlpPropertiesConfigAdapter createAdapter() {
-		return new OtlpPropertiesConfigAdapter(this.properties, this.openTelemetryProperties, this.environment);
+		return new OtlpPropertiesConfigAdapter(this.properties, this.openTelemetryProperties, this.connectionDetails,
+				this.environment);
 	}
 
 }

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

@@ -19,6 +19,7 @@
 import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter;
 import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
+import okhttp3.HttpUrl;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.boot.autoconfigure.AutoConfigurations;
@@ -34,6 +35,7 @@
  *
  * @author Jonatan Ivanov
  * @author Moritz Halbritter
+ * @author Eddú Meléndez
  */
 class OtlpAutoConfigurationTests {
 
@@ -106,6 +108,24 @@ void shouldNotSupplyOtlpHttpSpanExporterIfTracingIsDisabled() {
 			.run((context) -> assertThat(context).doesNotHaveBean(OtlpHttpSpanExporter.class));
 	}
 
+	@Test
+	void definesPropertiesBasedConnectionDetailsByDefault() {
+		this.contextRunner.withPropertyValues("management.otlp.tracing.endpoint=http://localhost:4318/v1/traces")
+			.run((context) -> assertThat(context)
+				.hasSingleBean(OtlpAutoConfiguration.PropertiesOtlpTracingConnectionDetails.class));
+	}
+
+	@Test
+	void testConnectionFactoryWithOverridesWhenUsingCustomConnectionDetails() {
+		this.contextRunner.withUserConfiguration(ConnectionDetailsConfiguration.class).run((context) -> {
+			assertThat(context).hasSingleBean(OtlpTracingConnectionDetails.class)
+				.doesNotHaveBean(OtlpAutoConfiguration.PropertiesOtlpTracingConnectionDetails.class);
+			OtlpHttpSpanExporter otlpHttpSpanExporter = context.getBean(OtlpHttpSpanExporter.class);
+			assertThat(otlpHttpSpanExporter).extracting("delegate.httpSender.url")
+				.isEqualTo(HttpUrl.get("http://localhost:12345/v1/traces"));
+		});
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	private static class CustomHttpExporterConfiguration {
 
@@ -126,4 +146,14 @@ OtlpGrpcSpanExporter customOtlpGrpcSpanExporter() {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	static class ConnectionDetailsConfiguration {
+
+		@Bean
+		OtlpTracingConnectionDetails otlpTracingConnectionDetails() {
+			return () -> "http://localhost:12345/v1/traces";
+		}
+
+	}
+
 }

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

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2012-2023 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.docker.compose.service.connection.otlp;
+
+import org.springframework.boot.actuate.autoconfigure.metrics.export.otlp.OtlpConnectionDetails;
+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;
+
+/**
+ * {@link DockerComposeConnectionDetailsFactory} to create {@link OtlpConnectionDetails}
+ * for a {@code otlp} service.
+ *
+ * @author Eddú Meléndez
+ */
+class OpenTelemetryDockerComposeConnectionDetailsFactory
+		extends DockerComposeConnectionDetailsFactory<OtlpConnectionDetails> {
+
+	private static final int OTLP_PORT = 4318;
+
+	OpenTelemetryDockerComposeConnectionDetailsFactory() {
+		super("otel/opentelemetry-collector-contrib",
+				"org.springframework.boot.actuate.autoconfigure.metrics.export.otlp.OtlpMetricsExportAutoConfiguration");
+	}
+
+	@Override
+	protected OtlpConnectionDetails getDockerComposeConnectionDetails(DockerComposeConnectionSource source) {
+		return new OpenTelemetryContainerConnectionDetails(source.getRunningService());
+	}
+
+	private static final class OpenTelemetryContainerConnectionDetails extends DockerComposeConnectionDetails
+			implements OtlpConnectionDetails {
+
+		private final String host;
+
+		private final int port;
+
+		private OpenTelemetryContainerConnectionDetails(RunningService source) {
+			super(source);
+			this.host = source.host();
+			this.port = source.ports().get(OTLP_PORT);
+		}
+
+		@Override
+		public String getUrl() {
+			return "http://" + this.host + ":" + this.port + "/v1/metrics";
+		}
+
+	}
+
+}