Add auto-configuration for OpenTelemetry SdkMeterProvider #46640
Conversation
Signed-off-by: Thomas Vitale <[email protected]>
spring-projects-issues
added
the
status: waiting-for-triage
| ObjectProvider<SdkMeterProviderBuilderCustomizer> customizers) { | ||
| SdkMeterProviderBuilder builder = SdkMeterProvider.builder().setClock(clock).setResource(resource); | ||
| if (properties.getExemplars().isEnabled()) { | ||
| SdkMeterProviderUtil.setExemplarFilter(builder, exemplarFilter); |
There was a problem hiding this comment.
Exemplars are disabled by default because even though the Spec/API is GA, the method in the Java SDK to configure them is not exposed publicly, but through this util. Is that acceptable for Spring Boot?
The API (mapped closely by the configuration properties) won't change as it's stable. So, any change to the SDK internals will not require any code/configuration change from Spring Boot users (a.k.a. stable feature). See: https://opentelemetry.io/docs/specs/otel/metrics/sdk/#exemplar (stable API). More context: open-telemetry/opentelemetry-java#7503.
My recommendation would be to keep this functionality, but disabled by default. Considering that the OTLP Meter Registry doesn't support exemplars yet, this would be the only way in Spring Boot to support exemplars in OpenTelemetry.
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean | ||
| @ConditionalOnBean({ Clock.class, Resource.class }) |
There was a problem hiding this comment.
This won't work reliably without auto-configuration ordering, e.g.
@AutoConfiguration(after = OpenTelemetrySdkAutoConfiguration.class)
The logging auto-configuration doesn't have those conditionals, so i think it's okay to drop them here too.
| ObjectProvider<SdkMeterProviderBuilderCustomizer> customizers) { | ||
| SdkMeterProviderBuilder builder = SdkMeterProvider.builder().setClock(clock).setResource(resource); | ||
| if (properties.getExemplars().isEnabled()) { | ||
| SdkMeterProviderUtil.setExemplarFilter(builder, exemplarFilter); |
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean | ||
| @ConditionalOnBean(OpenTelemetry.class) |
| /** | ||
| * Maximum number of distinct points per metric. | ||
| */ | ||
| private Integer cardinalityLimit = 2000; |
There was a problem hiding this comment.
This could be an int, couldn't it?
| * | ||
| * @author Thomas Vitale | ||
| */ | ||
| class OpenTelemetryMetricsPropertiesTests { |
There was a problem hiding this comment.
I don't see much value in these tests, as they only exercise a POJO class.
|
Thanks for the PR @ThomasVitale . Before we merge this, we need to decide on #36546 (comment), because this PR provides OTel beans but no way of exporting the metrics to a backend. |
mhalbritter
added
the
status: waiting-for-feedback
metricssub-package in thespring-boot-opentelemetrymodule.SdkMeterProviderwith customisation options via configuration properties and customizer bean.Clockbean used to initialise observability signals providers.Fixes gh-36546