Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove default value for OtlpMetricsProperties.url #44493

Closed
wants to merge 1 commit into from
Closed

Remove default value for OtlpMetricsProperties.url #44493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ dependencies {
testImplementation("org.springframework.restdocs:spring-restdocs-webtestclient")
testImplementation("org.springframework.security:spring-security-test")
testImplementation("org.yaml:snakeyaml")
testImplementation("uk.org.webcompere:system-stubs-jupiter:2.1.7")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This library has been added for mocking environment variables. But on the GitHub page it says:

From JDK16 onwards, there are deeper restrictions on the ability to use reflection. [...] Consequently, this library now uses bytebuddy to enable the interception of calls for reading environment variables. This might interact with your chosen version of Mockito or other libraries.

I wanted to know the team's opinion if we want to have that library for tests or if we want to ditch the tests (whenPropertiesUrlIsNotSetAndOtelExporterOtlpEndpointIsSetAdapterUrlUsesIt and whenPropertiesUrlIsNotSetAndOtelExporterOtlpMetricsEndpointIsSetAdapterUrlUsesIt).

Copy link
Contributor

@nosan nosan Mar 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like these tests verify the Micrometer OtlpConfig implementation rather than the OtlpMetricsPropertiesConfigAdapter.

I believe OtlpMetricsPropertiesConfigAdapter tests can be a little updated to ensure that
adapter delegates to OtlpConfig.url() when the URL is not set.

@Test
void whenPropertiesUrlIsNotSetAdapterUrlReturnsDefault() {
	assertThat(this.properties.getUrl()).isNull();
	assertThat(createAdapter().url()).isEqualTo("http://localhost:4318/v1/metrics");
}

@Test
void whenPropertiesUrlIsNotSetThanUseOtlpConfigUrlAsFallback() {
	assertThat(this.properties.getUrl()).isNull();
	OtlpMetricsPropertiesConfigAdapter adapter = spy(createAdapter());
	when(adapter.get("management.otlp.metrics.export.url")).thenReturn("https://my-endpoint/v1/metrics");
	assertThat(adapter.url()).isEqualTo("https://my-endpoint/v1/metrics");
}

In that case, uk.org.webcompere:system-stubs-jupiter:2.1.7 is unnecessary.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not in favor of trying to mock environment variables so +1 for @nosan's suggestion.

More generally, where we need to test environment variables, we try to allow the Map to be injected for testing purposes. If third-party code doesn't allow that then I'd prefer that we accept that it can't be tested rather than relying on reflection to hack into System.getenv.


testRuntimeOnly("jakarta.management.j2ee:jakarta.management.j2ee-api")
testRuntimeOnly("jakarta.transaction:jakarta.transaction-api")
Expand Down
2 changes: 1 addition & 1 deletion ...springframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpMetricsProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public class OtlpMetricsProperties extends StepRegistryProperties {
/**
* URI of the OTLP server.
*/
private String url = "http://localhost:4318/v1/metrics";
private String url;

/**
* Aggregation temporality of sums. It defines the way additive values are expressed.
Expand Down
18 changes: 18 additions & 0 deletions ...ot/actuate/autoconfigure/metrics/export/otlp/OtlpMetricsPropertiesConfigAdapterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import io.micrometer.registry.otlp.HistogramFlavor;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import uk.org.webcompere.systemstubs.SystemStubs;

import org.springframework.boot.actuate.autoconfigure.metrics.export.otlp.OtlpMetricsExportAutoConfiguration.PropertiesOtlpMetricsConnectionDetails;
import org.springframework.boot.actuate.autoconfigure.opentelemetry.OpenTelemetryProperties;
Expand Down Expand Up @@ -54,6 +55,23 @@ void setUp() {
this.connectionDetails = new PropertiesOtlpMetricsConnectionDetails(this.properties);
}

@Test
void whenPropertiesUrlIsNotSetAdapterUrlReturnsDefault() {
assertThat(createAdapter().url()).isEqualTo("http://localhost:4318/v1/metrics");
}

@Test
void whenPropertiesUrlIsNotSetAndOtelExporterOtlpEndpointIsSetAdapterUrlUsesIt() throws Exception {
SystemStubs.withEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT", "https://my-endpoint")
.execute(() -> assertThat(createAdapter().url()).isEqualTo("https://my-endpoint/v1/metrics"));
}

@Test
void whenPropertiesUrlIsNotSetAndOtelExporterOtlpMetricsEndpointIsSetAdapterUrlUsesIt() throws Exception {
SystemStubs.withEnvironmentVariable("OTEL_EXPORTER_OTLP_METRICS_ENDPOINT", "https://my-endpoint")
.execute(() -> assertThat(createAdapter().url()).isEqualTo("https://my-endpoint/v1/metrics"));
}

@Test
void whenPropertiesUrlIsSetAdapterUrlReturnsIt() {
this.properties.setUrl("http://another-url:4318/v1/metrics");
Expand Down
1 change: 0 additions & 1 deletion ...gframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpMetricsPropertiesTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ void defaultValuesAreConsistent() {
OtlpMetricsProperties properties = new OtlpMetricsProperties();
OtlpConfig config = OtlpConfig.DEFAULT;
assertStepRegistryDefaultValues(properties, config);
assertThat(properties.getUrl()).isEqualTo(config.url());
assertThat(properties.getAggregationTemporality()).isSameAs(config.aggregationTemporality());
assertThat(properties.getHistogramFlavor()).isSameAs(config.histogramFlavor());
assertThat(properties.getMaxScale()).isEqualTo(config.maxScale());
Expand Down