From e0e290be65d9edfd36e794d3828dcbf3a90d5fa1 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Fri, 29 Nov 2024 16:56:20 +0100 Subject: [PATCH 1/7] add support for missing spring list properties --- .../properties/OtelSpringProperties.java | 194 ++++++++++++++++++ .../properties/SpringConfigProperties.java | 43 +++- ...itional-spring-configuration-metadata.json | 4 +- .../AbstractOtelSpringStarterSmokeTest.java | 15 +- .../src/main/resources/application.yaml | 1 + 5 files changed, 248 insertions(+), 9 deletions(-) diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java index 39add550f4ed..85f209deefc0 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java +++ b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java @@ -195,12 +195,142 @@ public void setResource(Resource resource) { } } + public static final class Logs { + private List exporters = Collections.emptyList(); + + public List getExporters() { + return exporters; + } + + public void setExporters(List exporters) { + this.exporters = exporters; + } + } + + public static final class Metrics { + private List exporters = Collections.emptyList(); + + public List getExporters() { + return exporters; + } + + public void setExporters(List exporters) { + this.exporters = exporters; + } + } + + public static final class Traces { + private List exporters = Collections.emptyList(); + + public List getExporters() { + return exporters; + } + + public void setExporters(List exporters) { + this.exporters = exporters; + } + } + + private static final class Instrumentation { + private static final class Http { + private static final class Client { + private List captureRequestHeaders = Collections.emptyList(); + private List captureResponseHeaders = Collections.emptyList(); + + public List getCaptureRequestHeaders() { + return captureRequestHeaders; + } + + public void setCaptureRequestHeaders(List captureRequestHeaders) { + this.captureRequestHeaders = captureRequestHeaders; + } + + public List getCaptureResponseHeaders() { + return captureResponseHeaders; + } + + public void setCaptureResponseHeaders(List captureResponseHeaders) { + this.captureResponseHeaders = captureResponseHeaders; + } + } + + private static final class Server { + private List captureRequestHeaders = Collections.emptyList(); + private List captureResponseHeaders = Collections.emptyList(); + + public List getCaptureRequestHeaders() { + return captureRequestHeaders; + } + + public void setCaptureRequestHeaders(List captureRequestHeaders) { + this.captureRequestHeaders = captureRequestHeaders; + } + + public List getCaptureResponseHeaders() { + return captureResponseHeaders; + } + + public void setCaptureResponseHeaders(List captureResponseHeaders) { + this.captureResponseHeaders = captureResponseHeaders; + } + } + + private Client client = new Client(); + + private Server server = new Server(); + + private List knownMethods = Collections.emptyList(); + + public Client getClient() { + return client; + } + + public void setClient(Client client) { + this.client = client; + } + + public Server getServer() { + return server; + } + + public void setServer(Server server) { + this.server = server; + } + + public List getKnownMethods() { + return knownMethods; + } + + public void setKnownMethods(List knownMethods) { + this.knownMethods = knownMethods; + } + } + + private Http http = new Http(); + + public Http getHttp() { + return http; + } + + public void setHttp(Http http) { + this.http = http; + } + } + private List propagators = Collections.emptyList(); private Java java = new Java(); private Experimental experimental = new Experimental(); + private Logs logs = new Logs(); + + private Metrics metrics = new Metrics(); + + private Traces traces = new Traces(); + + private Instrumentation instrumentation = new Instrumentation(); + public List getPropagators() { return propagators; } @@ -225,6 +355,38 @@ public void setExperimental(Experimental experimental) { this.experimental = experimental; } + public Logs getLogs() { + return logs; + } + + public void setLogs(Logs logs) { + this.logs = logs; + } + + public Metrics getMetrics() { + return metrics; + } + + public void setMetrics(Metrics metrics) { + this.metrics = metrics; + } + + public Traces getTraces() { + return traces; + } + + public void setTraces(Traces traces) { + this.traces = traces; + } + + public Instrumentation getInstrumentation() { + return instrumentation; + } + + public void setInstrumentation(Instrumentation instrumentation) { + this.instrumentation = instrumentation; + } + public List getJavaEnabledResourceProviders() { return java.getEnabled().getResource().getProviders(); } @@ -240,4 +402,36 @@ public List getExperimentalMetricsViewConfig() { public List getExperimentalResourceDisabledKeys() { return experimental.getResource().getDisabled().getKeys(); } + + public List getLogsExporter() { + return logs.getExporters(); + } + + public List getMetricsExporter() { + return metrics.getExporters(); + } + + public List getTracesExporter() { + return traces.getExporters(); + } + + public List getHttpClientCaptureRequestHeaders() { + return instrumentation.getHttp().getClient().getCaptureRequestHeaders(); + } + + public List getHttpClientCaptureResponseHeaders() { + return instrumentation.getHttp().getClient().getCaptureResponseHeaders(); + } + + public List getHttpServerCaptureRequestHeaders() { + return instrumentation.getHttp().getServer().getCaptureRequestHeaders(); + } + + public List getHttpServerCaptureResponseHeaders() { + return instrumentation.getHttp().getServer().getCaptureResponseHeaders(); + } + + public List getHttpKnownMethods() { + return instrumentation.getHttp().getKnownMethods(); + } } diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java index 82c400f6f362..9a29f0f05457 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java +++ b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java @@ -32,7 +32,7 @@ public class SpringConfigProperties implements ConfigProperties { private final OtelResourceProperties resourceProperties; private final ConfigProperties otelSdkProperties; private final ConfigProperties customizedListProperties; - private final Map> listPropertyValues = new HashMap<>(); + private final Map> listPropertyValues; static final String DISABLED_KEY = "otel.java.disabled.resource.providers"; static final String ENABLED_KEY = "otel.java.enabled.resource.providers"; @@ -52,15 +52,46 @@ public SpringConfigProperties( this.customizedListProperties = createCustomizedListProperties(otelSdkProperties, otelSpringProperties); - listPropertyValues.put(ENABLED_KEY, otelSpringProperties.getJavaEnabledResourceProviders()); - listPropertyValues.put(DISABLED_KEY, otelSpringProperties.getJavaDisabledResourceProviders()); - listPropertyValues.put( + listPropertyValues = createListPropertyValues(otelSpringProperties); + } + + private static Map> createListPropertyValues( + OtelSpringProperties otelSpringProperties) { + Map> values = new HashMap<>(); + + // SDK + values.put(ENABLED_KEY, otelSpringProperties.getJavaEnabledResourceProviders()); + values.put(DISABLED_KEY, otelSpringProperties.getJavaDisabledResourceProviders()); + values.put( "otel.experimental.metrics.view.config", otelSpringProperties.getExperimentalMetricsViewConfig()); - listPropertyValues.put( + values.put( "otel.experimental.resource.disabled.keys", otelSpringProperties.getExperimentalResourceDisabledKeys()); - listPropertyValues.put("otel.propagators", otelSpringProperties.getPropagators()); + values.put("otel.propagators", otelSpringProperties.getPropagators()); + + // exporters + values.put("otel.logs.exporter", otelSpringProperties.getLogsExporter()); + values.put("otel.metrics.exporter", otelSpringProperties.getMetricsExporter()); + values.put("otel.traces.exporter", otelSpringProperties.getTracesExporter()); + + // instrumentations + values.put( + "otel.instrumentation.http.client.capture-request-headers", + otelSpringProperties.getHttpClientCaptureRequestHeaders()); + values.put( + "otel.instrumentation.http.client.capture-response-headers", + otelSpringProperties.getHttpClientCaptureResponseHeaders()); + values.put( + "otel.instrumentation.http.server.capture-request-headers", + otelSpringProperties.getHttpServerCaptureRequestHeaders()); + values.put( + "otel.instrumentation.http.server.capture-response-headers", + otelSpringProperties.getHttpServerCaptureResponseHeaders()); + values.put( + "otel.instrumentation.http.known-methods", otelSpringProperties.getHttpKnownMethods()); + + return values; } private static Map createMapForListProperty( diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index a0b04d97f9fc..9d53d0c17e94 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -425,8 +425,8 @@ }, { "name": "otel.instrumentation.logback-appender.experimental.capture-mdc-attributes", - "type": "java.util.List", - "description": "MDC attributes to capture. Use the wildcard character * to capture all attributes." + "type": "java.lang.String", + "description": "MDC attributes to capture. Use the wildcard character * to capture all attributes. This is a comma-separated list of attribute names.", }, { "name": "otel.instrumentation.logback-mdc.enabled", diff --git a/smoke-tests-otel-starter/spring-boot-common/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelSpringStarterSmokeTest.java b/smoke-tests-otel-starter/spring-boot-common/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelSpringStarterSmokeTest.java index ebec55db783f..0709434bc883 100644 --- a/smoke-tests-otel-starter/spring-boot-common/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelSpringStarterSmokeTest.java +++ b/smoke-tests-otel-starter/spring-boot-common/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelSpringStarterSmokeTest.java @@ -28,6 +28,7 @@ import io.opentelemetry.semconv.incubating.CodeIncubatingAttributes; import io.opentelemetry.semconv.incubating.DbIncubatingAttributes; import io.opentelemetry.semconv.incubating.ServiceIncubatingAttributes; +import java.net.URI; import java.util.Collections; import java.util.List; import org.assertj.core.api.AbstractCharSequenceAssert; @@ -46,6 +47,9 @@ import org.springframework.context.event.EventListener; import org.springframework.core.annotation.Order; import org.springframework.core.env.Environment; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.RequestEntity; import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.web.client.RestTemplate; @@ -142,7 +146,13 @@ void propertyConversion() { @Test @org.junit.jupiter.api.Order(1) void shouldSendTelemetry() { - testRestTemplate.getForObject(OtelSpringStarterSmokeTestController.PING, String.class); + HttpHeaders headers = new HttpHeaders(); + headers.add("key", "value"); + + testRestTemplate.exchange( + new RequestEntity<>( + null, headers, HttpMethod.GET, URI.create(OtelSpringStarterSmokeTestController.PING)), + String.class); // Span testing.waitAndAssertTraces( @@ -186,6 +196,9 @@ void shouldSendTelemetry() { equalTo(HttpAttributes.HTTP_ROUTE, "/ping"), equalTo(ServerAttributes.SERVER_ADDRESS, "localhost"), equalTo(ClientAttributes.CLIENT_ADDRESS, "127.0.0.1"), + equalTo( + AttributeKey.stringArrayKey("http.request.header.key"), + Collections.singletonList("value")), satisfies( ServerAttributes.SERVER_PORT, integerAssert -> integerAssert.isNotZero())), diff --git a/smoke-tests-otel-starter/spring-boot-common/src/main/resources/application.yaml b/smoke-tests-otel-starter/spring-boot-common/src/main/resources/application.yaml index b8aec4b09f6d..4da76f769a0d 100644 --- a/smoke-tests-otel-starter/spring-boot-common/src/main/resources/application.yaml +++ b/smoke-tests-otel-starter/spring-boot-common/src/main/resources/application.yaml @@ -13,6 +13,7 @@ otel: emit-experimental-telemetry: true server: emit-experimental-telemetry: true + capture-request-headers: [key] propagators: - b3 resource: From bf7411c3b427cbb055ff72fc8e85e8a4b2dd1393 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Fri, 29 Nov 2024 17:36:09 +0100 Subject: [PATCH 2/7] fix format --- .../META-INF/additional-spring-configuration-metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 9d53d0c17e94..68a06350a09d 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -426,7 +426,7 @@ { "name": "otel.instrumentation.logback-appender.experimental.capture-mdc-attributes", "type": "java.lang.String", - "description": "MDC attributes to capture. Use the wildcard character * to capture all attributes. This is a comma-separated list of attribute names.", + "description": "MDC attributes to capture. Use the wildcard character * to capture all attributes. This is a comma-separated list of attribute names." }, { "name": "otel.instrumentation.logback-mdc.enabled", From 2f2b773d826d0f1b9a72e2c98b1ef47243eb6ce1 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Sat, 30 Nov 2024 11:14:33 +0100 Subject: [PATCH 3/7] fix --- .../properties/OtelSpringProperties.java | 72 +++++++++---------- 1 file changed, 34 insertions(+), 38 deletions(-) diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java index 85f209deefc0..5906e6b350b3 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java +++ b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java @@ -195,31 +195,11 @@ public void setResource(Resource resource) { } } - public static final class Logs { - private List exporters = Collections.emptyList(); - - public List getExporters() { - return exporters; - } - - public void setExporters(List exporters) { - this.exporters = exporters; - } - } - - public static final class Metrics { - private List exporters = Collections.emptyList(); - - public List getExporters() { - return exporters; - } - - public void setExporters(List exporters) { - this.exporters = exporters; - } - } - - public static final class Traces { + /** + * This class is internal and is hence not for public use. Its APIs are unstable and can change at + * any time. + */ + public static final class HasExporters { private List exporters = Collections.emptyList(); public List getExporters() { @@ -231,9 +211,21 @@ public void setExporters(List exporters) { } } - private static final class Instrumentation { - private static final class Http { - private static final class Client { + /** + * This class is internal and is hence not for public use. Its APIs are unstable and can change at + * any time. + */ + public static final class Instrumentation { + /** + * This class is internal and is hence not for public use. Its APIs are unstable and can change + * at any time. + */ + public static final class Http { + /** + * This class is internal and is hence not for public use. Its APIs are unstable and can + * change at any time. + */ + public static final class Client { private List captureRequestHeaders = Collections.emptyList(); private List captureResponseHeaders = Collections.emptyList(); @@ -254,7 +246,11 @@ public void setCaptureResponseHeaders(List captureResponseHeaders) { } } - private static final class Server { + /** + * This class is internal and is hence not for public use. Its APIs are unstable and can + * change at any time. + */ + public static final class Server { private List captureRequestHeaders = Collections.emptyList(); private List captureResponseHeaders = Collections.emptyList(); @@ -323,11 +319,11 @@ public void setHttp(Http http) { private Experimental experimental = new Experimental(); - private Logs logs = new Logs(); + private HasExporters logs = new HasExporters(); - private Metrics metrics = new Metrics(); + private HasExporters metrics = new HasExporters(); - private Traces traces = new Traces(); + private HasExporters traces = new HasExporters(); private Instrumentation instrumentation = new Instrumentation(); @@ -355,27 +351,27 @@ public void setExperimental(Experimental experimental) { this.experimental = experimental; } - public Logs getLogs() { + public HasExporters getLogs() { return logs; } - public void setLogs(Logs logs) { + public void setLogs(HasExporters logs) { this.logs = logs; } - public Metrics getMetrics() { + public HasExporters getMetrics() { return metrics; } - public void setMetrics(Metrics metrics) { + public void setMetrics(HasExporters metrics) { this.metrics = metrics; } - public Traces getTraces() { + public HasExporters getTraces() { return traces; } - public void setTraces(Traces traces) { + public void setTraces(HasExporters traces) { this.traces = traces; } From 45c54121478f9e066eff8c2d92e77e7c68698b3d Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Mon, 2 Dec 2024 11:24:02 +0100 Subject: [PATCH 4/7] fix --- .../properties/OtelSpringProperties.java | 16 ++++++++-------- .../properties/SpringConfigProperties.java | 4 +++- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java index 5906e6b350b3..4f50d260f7ca 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java +++ b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtelSpringProperties.java @@ -200,14 +200,14 @@ public void setResource(Resource resource) { * any time. */ public static final class HasExporters { - private List exporters = Collections.emptyList(); + private List exporter = Collections.emptyList(); - public List getExporters() { - return exporters; + public List getExporter() { + return exporter; } - public void setExporters(List exporters) { - this.exporters = exporters; + public void setExporter(List exporter) { + this.exporter = exporter; } } @@ -400,15 +400,15 @@ public List getExperimentalResourceDisabledKeys() { } public List getLogsExporter() { - return logs.getExporters(); + return logs.getExporter(); } public List getMetricsExporter() { - return metrics.getExporters(); + return metrics.getExporter(); } public List getTracesExporter() { - return traces.getExporters(); + return traces.getExporter(); } public List getHttpClientCaptureRequestHeaders() { diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java index 9a29f0f05457..05efa521d59a 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java +++ b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java @@ -205,7 +205,9 @@ public List getList(String name) { if (!c.isEmpty()) { return c; } - return list; + if (!list.isEmpty()) { + return list; + } } return or(environment.getProperty(normalizedName, List.class), otelSdkProperties.getList(name)); From c1f45fbcee6b29cfc750577a7c483c662785f2b7 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Thu, 12 Dec 2024 11:25:16 +0100 Subject: [PATCH 5/7] clean up test --- ...t.java => SpringConfigPropertiesTest.java} | 53 ++++++++++++--- .../resources/SpringConfigPropertiesTest.java | 67 ------------------- 2 files changed, 43 insertions(+), 77 deletions(-) rename instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/{OtlpExporterPropertiesTest.java => SpringConfigPropertiesTest.java} (70%) delete mode 100644 instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/resources/SpringConfigPropertiesTest.java diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtlpExporterPropertiesTest.java b/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java similarity index 70% rename from instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtlpExporterPropertiesTest.java rename to instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java index 3cfaa03b5227..7ff6ed383b7d 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/OtlpExporterPropertiesTest.java +++ b/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java @@ -13,6 +13,8 @@ import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties; import java.util.Arrays; import java.util.Collections; +import java.util.HashMap; +import java.util.Map; import java.util.stream.Stream; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; @@ -25,7 +27,12 @@ import org.springframework.core.env.Environment; import org.springframework.expression.spel.standard.SpelExpressionParser; -class OtlpExporterPropertiesTest { +class SpringConfigPropertiesTest { + private final ApplicationContextRunner contextRunner = + new ApplicationContextRunner() + .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class)) + .withPropertyValues( + "otel.traces.exporter=none", "otel.metrics.exporter=none", "otel.logs.exporter=none"); private static final String[] HEADER_KEYS = { "otel.exporter.otlp.traces.headers", @@ -34,12 +41,6 @@ class OtlpExporterPropertiesTest { "otel.exporter.otlp.headers", }; - private final ApplicationContextRunner contextRunner = - new ApplicationContextRunner() - .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class)) - .withPropertyValues( - "otel.traces.exporter=none", "otel.metrics.exporter=none", "otel.logs.exporter=none"); - public static Stream headerKeys() { return Arrays.stream(HEADER_KEYS).map(Arguments::of); } @@ -86,13 +87,45 @@ void mapObjectHeaders(String key) { .containsExactly(entry("a", "1"), entry("b", "2"))); } + @Test + @DisplayName("when map is set in properties in a row it should be available in config") + void shouldInitializeAttributesByMapInARow() { + this.contextRunner + .withPropertyValues( + "otel.resource.attributes.environment=dev", + "otel.resource.attributes.xyz=foo", + "otel.resource.attributes.service.instance.id=id-example") + .run( + context -> { + Map fallback = new HashMap<>(); + fallback.put("fallback", "fallbackVal"); + fallback.put("otel.resource.attributes", "foo=fallback"); + + SpringConfigProperties config = getConfig(context, fallback); + + assertThat(config.getMap("otel.resource.attributes")) + .contains( + entry("environment", "dev"), + entry("xyz", "foo"), + entry("service.instance.id", "id-example"), + entry("foo", "fallback")); + + assertThat(config.getString("fallback")).isEqualTo("fallbackVal"); + }); + } + private static ConfigProperties getConfig(AssertableApplicationContext context) { + return getConfig(context, Collections.emptyMap()); + } + + private static SpringConfigProperties getConfig( + AssertableApplicationContext context, Map fallback) { return new SpringConfigProperties( context.getBean("environment", Environment.class), new SpelExpressionParser(), context.getBean(OtlpExporterProperties.class), - new OtelResourceProperties(), - new OtelSpringProperties(), - DefaultConfigProperties.createFromMap(Collections.emptyMap())); + context.getBean(OtelResourceProperties.class), + context.getBean(OtelSpringProperties.class), + DefaultConfigProperties.createFromMap(fallback)); } } diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/resources/SpringConfigPropertiesTest.java b/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/resources/SpringConfigPropertiesTest.java deleted file mode 100644 index 2646837ed789..000000000000 --- a/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/resources/SpringConfigPropertiesTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * Copyright The OpenTelemetry Authors - * SPDX-License-Identifier: Apache-2.0 - */ - -package io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources; - -import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.entry; - -import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration; -import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties; -import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelSpringProperties; -import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties; -import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties; -import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties; -import java.util.HashMap; -import java.util.Map; -import org.junit.jupiter.api.DisplayName; -import org.junit.jupiter.api.Test; -import org.springframework.boot.autoconfigure.AutoConfigurations; -import org.springframework.boot.test.context.runner.ApplicationContextRunner; -import org.springframework.core.env.Environment; -import org.springframework.expression.spel.standard.SpelExpressionParser; - -class SpringConfigPropertiesTest { - private final ApplicationContextRunner contextRunner = new ApplicationContextRunner(); - - @Test - @DisplayName("when map is set in properties in a row it should be available in config") - void shouldInitializeAttributesByMapInArow() { - this.contextRunner - .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class)) - .withPropertyValues( - "otel.metrics.exporter=none", // to suppress confusing error log - "otel.logs.exporter=none", - "otel.traces.exporter=none", - "otel.resource.attributes.environment=dev", - "otel.resource.attributes.xyz=foo", - "otel.resource.attributes.service.instance.id=id-example") - .run( - context -> { - Environment env = context.getBean("environment", Environment.class); - Map fallback = new HashMap<>(); - fallback.put("fallback", "fallbackVal"); - fallback.put("otel.resource.attributes", "foo=fallback"); - - SpringConfigProperties config = - new SpringConfigProperties( - env, - new SpelExpressionParser(), - context.getBean(OtlpExporterProperties.class), - context.getBean(OtelResourceProperties.class), - context.getBean(OtelSpringProperties.class), - DefaultConfigProperties.createFromMap(fallback)); - - assertThat(config.getMap("otel.resource.attributes")) - .contains( - entry("environment", "dev"), - entry("xyz", "foo"), - entry("service.instance.id", "id-example"), - entry("foo", "fallback")); - - assertThat(config.getString("fallback")).isEqualTo("fallbackVal"); - }); - } -} From 03a6fd2128e0eabc2cd704efb80df16b26c5645b Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Thu, 12 Dec 2024 12:27:59 +0100 Subject: [PATCH 6/7] add spring properties test --- .../SpringConfigPropertiesTest.java | 60 ++++++++++++++++--- .../src/test/resources/application.yaml | 25 ++++++++ 2 files changed, 76 insertions(+), 9 deletions(-) create mode 100644 instrumentation/spring/spring-boot-autoconfigure/src/test/resources/application.yaml diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java b/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java index 7ff6ed383b7d..66f6acc8f3e4 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java +++ b/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java @@ -14,6 +14,7 @@ import java.util.Arrays; import java.util.Collections; import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.stream.Stream; import org.junit.jupiter.api.DisplayName; @@ -22,6 +23,7 @@ import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; import org.springframework.boot.autoconfigure.AutoConfigurations; +import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer; import org.springframework.boot.test.context.assertj.AssertableApplicationContext; import org.springframework.boot.test.context.runner.ApplicationContextRunner; import org.springframework.core.env.Environment; @@ -34,15 +36,15 @@ class SpringConfigPropertiesTest { .withPropertyValues( "otel.traces.exporter=none", "otel.metrics.exporter=none", "otel.logs.exporter=none"); - private static final String[] HEADER_KEYS = { - "otel.exporter.otlp.traces.headers", - "otel.exporter.otlp.metrics.headers", - "otel.exporter.otlp.logs.headers", - "otel.exporter.otlp.headers", - }; - public static Stream headerKeys() { - return Arrays.stream(HEADER_KEYS).map(Arguments::of); + return Arrays.stream( + new String[] { + "otel.exporter.otlp.traces.headers", + "otel.exporter.otlp.metrics.headers", + "otel.exporter.otlp.logs.headers", + "otel.exporter.otlp.headers", + }) + .map(Arguments::of); } @Test @@ -87,9 +89,49 @@ void mapObjectHeaders(String key) { .containsExactly(entry("a", "1"), entry("b", "2"))); } + public static Stream listProperties() { + return Arrays.stream( + new String[] { + "otel.experimental.metrics.view.config", + "otel.experimental.resource.disabled.keys", + "otel.propagators", + "otel.logs.exporter", + "otel.metrics.exporter", + "otel.traces.exporter", + "otel.instrumentation.http.client.capture-request-headers", + "otel.instrumentation.http.client.capture-response-headers", + "otel.instrumentation.http.server.capture-request-headers", + "otel.instrumentation.http.server.capture-response-headers", + "otel.instrumentation.http.known-methods", + }) + .map(Arguments::of); + } + + @ParameterizedTest + @MethodSource("listProperties") + @DisplayName("should map list from application.yaml list") + void listsShouldWorkWithYaml(String key) { + List expected; + if (key.equals("otel.propagators")) { + expected = Arrays.asList("baggage", "b3"); + } else if (key.endsWith(".exporter")) { + expected = Collections.singletonList("console"); + } else { + expected = Arrays.asList("a", "b"); + } + + new ApplicationContextRunner() + .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class)) + .withInitializer(new ConfigDataApplicationContextInitializer()) + .run( + context -> + assertThat(getConfig(context).getList(key)) + .containsExactlyInAnyOrderElementsOf(expected)); + } + @Test @DisplayName("when map is set in properties in a row it should be available in config") - void shouldInitializeAttributesByMapInARow() { + void shouldInitializeAttributesByMap() { this.contextRunner .withPropertyValues( "otel.resource.attributes.environment=dev", diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/test/resources/application.yaml b/instrumentation/spring/spring-boot-autoconfigure/src/test/resources/application.yaml new file mode 100644 index 000000000000..c9485005a6a7 --- /dev/null +++ b/instrumentation/spring/spring-boot-autoconfigure/src/test/resources/application.yaml @@ -0,0 +1,25 @@ +otel: + experimental: + metrics: + view: + config: [ a,b ] + resource: + disabled: + keys: [ a,b ] + propagators: [ baggage, b3 ] + logs: + exporter: [ console ] + metrics: + exporter: [ console ] + traces: + exporter: [ console ] + + instrumentation: + http: + known-methods: [ a,b ] + client: + capture-request-headers: [ a,b ] + capture-response-headers: [ a,b ] + server: + capture-request-headers: [ a,b ] + capture-response-headers: [ a,b ] From e07f971146ecfe06242b4c7125650b7dc9938367 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Thu, 12 Dec 2024 14:54:26 +0100 Subject: [PATCH 7/7] cleanup --- .../SpringConfigPropertiesTest.java | 43 ++++++++----------- 1 file changed, 18 insertions(+), 25 deletions(-) diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java b/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java index 66f6acc8f3e4..8bb38dc453cf 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java +++ b/instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigPropertiesTest.java @@ -90,36 +90,29 @@ void mapObjectHeaders(String key) { } public static Stream listProperties() { - return Arrays.stream( - new String[] { - "otel.experimental.metrics.view.config", - "otel.experimental.resource.disabled.keys", - "otel.propagators", - "otel.logs.exporter", - "otel.metrics.exporter", - "otel.traces.exporter", - "otel.instrumentation.http.client.capture-request-headers", - "otel.instrumentation.http.client.capture-response-headers", - "otel.instrumentation.http.server.capture-request-headers", - "otel.instrumentation.http.server.capture-response-headers", - "otel.instrumentation.http.known-methods", - }) - .map(Arguments::of); + return Stream.of( + Arguments.of("otel.experimental.metrics.view.config", Arrays.asList("a", "b")), + Arguments.of("otel.experimental.resource.disabled.keys", Arrays.asList("a", "b")), + Arguments.of("otel.propagators", Arrays.asList("baggage", "b3")), + Arguments.of("otel.logs.exporter", Collections.singletonList("console")), + Arguments.of("otel.metrics.exporter", Collections.singletonList("console")), + Arguments.of("otel.traces.exporter", Collections.singletonList("console")), + Arguments.of( + "otel.instrumentation.http.client.capture-request-headers", Arrays.asList("a", "b")), + Arguments.of( + "otel.instrumentation.http.client.capture-response-headers", Arrays.asList("a", "b")), + Arguments.of( + "otel.instrumentation.http.server.capture-request-headers", Arrays.asList("a", "b")), + Arguments.of( + "otel.instrumentation.http.server.capture-response-headers", Arrays.asList("a", "b")), + Arguments.of("otel.instrumentation.http.known-methods", Arrays.asList("a", "b"))); } @ParameterizedTest @MethodSource("listProperties") @DisplayName("should map list from application.yaml list") - void listsShouldWorkWithYaml(String key) { - List expected; - if (key.equals("otel.propagators")) { - expected = Arrays.asList("baggage", "b3"); - } else if (key.endsWith(".exporter")) { - expected = Collections.singletonList("console"); - } else { - expected = Arrays.asList("a", "b"); - } - + // See the application.yaml file + void listsShouldWorkWithYaml(String key, List expected) { new ApplicationContextRunner() .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class)) .withInitializer(new ConfigDataApplicationContextInitializer())