Skip to content

Auto-configure OtlpMetricsSender if available #45204

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.

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@
import io.micrometer.core.instrument.Clock;
import io.micrometer.registry.otlp.OtlpConfig;
import io.micrometer.registry.otlp.OtlpMeterRegistry;
import io.micrometer.registry.otlp.OtlpMeterRegistry.Builder;
import io.micrometer.registry.otlp.OtlpMetricsSender;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration;
import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
import org.springframework.boot.actuate.autoconfigure.metrics.export.ConditionalOnEnabledMetricsExport;
Expand Down Expand Up @@ -76,16 +79,24 @@ OtlpConfig otlpConfig(OpenTelemetryProperties openTelemetryProperties,
@Bean
@ConditionalOnMissingBean
@ConditionalOnThreading(Threading.PLATFORM)
public OtlpMeterRegistry otlpMeterRegistry(OtlpConfig otlpConfig, Clock clock) {
return new OtlpMeterRegistry(otlpConfig, clock);
public OtlpMeterRegistry otlpMeterRegistry(OtlpConfig otlpConfig, Clock clock,
ObjectProvider<OtlpMetricsSender> metricsSender) {
Builder builder = OtlpMeterRegistry.builder(otlpConfig).clock(clock);
metricsSender.ifAvailable(builder::metricsSender);
return builder.build();
}

@Bean
@ConditionalOnMissingBean
@ConditionalOnThreading(Threading.VIRTUAL)
public OtlpMeterRegistry otlpMeterRegistryVirtualThreads(OtlpConfig otlpConfig, Clock clock) {
public OtlpMeterRegistry otlpMeterRegistryVirtualThreads(OtlpConfig otlpConfig, Clock clock,
ObjectProvider<OtlpMetricsSender> metricsSender) {
VirtualThreadTaskExecutor taskExecutor = new VirtualThreadTaskExecutor("otlp-meter-registry-");
return new OtlpMeterRegistry(otlpConfig, clock, taskExecutor.getVirtualThreadFactory());
Builder builder = OtlpMeterRegistry.builder(otlpConfig)
.clock(clock)
.threadFactory(taskExecutor.getVirtualThreadFactory());
metricsSender.ifAvailable(builder::metricsSender);
return builder.build();
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import io.micrometer.core.instrument.Clock;
import io.micrometer.registry.otlp.OtlpConfig;
import io.micrometer.registry.otlp.OtlpMeterRegistry;
import io.micrometer.registry.otlp.OtlpMetricsSender;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledForJreRange;
import org.junit.jupiter.api.condition.JRE;
Expand Down Expand Up @@ -132,6 +133,32 @@ void testConnectionFactoryWithOverridesWhenUsingCustomConnectionDetails() {
});
}

@Test
void allowsCustomMetricsSenderToBeUsed() {
this.contextRunner.withUserConfiguration(BaseConfiguration.class, CustomMetricsSenderConfiguration.class)
.run((context) -> {
assertThat(context).hasSingleBean(OtlpMeterRegistry.class);
OtlpMeterRegistry registry = context.getBean(OtlpMeterRegistry.class);
assertThat(registry).extracting("metricsSender")
.satisfies((sender) -> assertThat(sender)
.isSameAs(CustomMetricsSenderConfiguration.customMetricsSender));
});
}

@Test
@EnabledForJreRange(min = JRE.JAVA_21)
void allowsCustomMetricsSenderToBeUsedWithVirtualThreads() {
this.contextRunner.withUserConfiguration(BaseConfiguration.class, CustomMetricsSenderConfiguration.class)
.withPropertyValues("spring.threads.virtual.enabled=true")
.run((context) -> {
assertThat(context).hasSingleBean(OtlpMeterRegistry.class);
OtlpMeterRegistry registry = context.getBean(OtlpMeterRegistry.class);
assertThat(registry).extracting("metricsSender")
.satisfies((sender) -> assertThat(sender)
.isSameAs(CustomMetricsSenderConfiguration.customMetricsSender));
});
}

@Configuration(proxyBeanMethods = false)
static class BaseConfiguration {

Expand Down Expand Up @@ -174,4 +201,17 @@ OtlpMetricsConnectionDetails otlpConnectionDetails() {

}

@Configuration(proxyBeanMethods = false)
static class CustomMetricsSenderConfiguration {

static OtlpMetricsSender customMetricsSender = (request) -> {
};

@Bean
OtlpMetricsSender customMetricsSender() {
return customMetricsSender;
}

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,8 @@ management:

Custom headers, for example for authentication, can also be provided using configprop:management.otlp.metrics.export.headers.*[] properties.

If an `OtlpMetricsSender` bean is available, it will be configured on the `OtlpMeterRegistry` that Spring Boot auto-configures.



[[actuator.metrics.export.prometheus]]
Expand Down