Skip to content

Update OtlpMetricExporterProvider to implement AutoConfigureListener #7541

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

Merged
merged 3 commits into from
Sep 11, 2025
Merged

Update OtlpMetricExporterProvider to implement AutoConfigureListener #7541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72f9b23
Update OtlpMetricExporterProvider to implement AutoConfigureListener
jaydeluca Aug 7, 2025
15dddeb
update test
jaydeluca Aug 7, 2025
c986681
add tests ensuring setMeterProvider is called as expected
jaydeluca Sep 11, 2025
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
17 changes: 16 additions & 1 deletion ...all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpMetricExporterProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@
import static io.opentelemetry.exporter.otlp.internal.OtlpConfigUtil.PROTOCOL_GRPC;
import static io.opentelemetry.exporter.otlp.internal.OtlpConfigUtil.PROTOCOL_HTTP_PROTOBUF;

import io.opentelemetry.api.metrics.MeterProvider;
import io.opentelemetry.exporter.internal.ExporterBuilderUtil;
import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter;
import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporterBuilder;
import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter;
import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporterBuilder;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
import io.opentelemetry.sdk.autoconfigure.spi.internal.AutoConfigureListener;
import io.opentelemetry.sdk.autoconfigure.spi.metrics.ConfigurableMetricExporterProvider;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import java.util.concurrent.atomic.AtomicReference;

/**
* {@link MetricExporter} SPI implementation for {@link OtlpGrpcMetricExporter} and {@link
Expand All @@ -26,7 +30,11 @@
* <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
* at any time.
*/
public class OtlpMetricExporterProvider implements ConfigurableMetricExporterProvider {
public class OtlpMetricExporterProvider
implements ConfigurableMetricExporterProvider, AutoConfigureListener {

private final AtomicReference<MeterProvider> meterProviderRef =
new AtomicReference<>(MeterProvider.noop());

@Override
public MetricExporter createExporter(ConfigProperties config) {
Expand All @@ -51,6 +59,7 @@ public MetricExporter createExporter(ConfigProperties config) {
config, builder::setAggregationTemporalitySelector);
ExporterBuilderUtil.configureOtlpHistogramDefaultAggregation(
config, builder::setDefaultAggregationSelector);
builder.setMeterProvider(meterProviderRef::get);

return builder.build();
} else if (protocol.equals(PROTOCOL_GRPC)) {
Expand All @@ -72,6 +81,7 @@ public MetricExporter createExporter(ConfigProperties config) {
config, builder::setAggregationTemporalitySelector);
ExporterBuilderUtil.configureOtlpHistogramDefaultAggregation(
config, builder::setDefaultAggregationSelector);
builder.setMeterProvider(meterProviderRef::get);
Copy link
Contributor

@jkwatson jkwatson Sep 9, 2025

Choose a reason for hiding this comment

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

I feel like it would be good to make sure we have tests that cover this particular line. The test addition doesn't seem to verify that we're actually doing this very important step.


return builder.build();
}
Expand All @@ -92,4 +102,9 @@ OtlpHttpMetricExporterBuilder httpBuilder() {
OtlpGrpcMetricExporterBuilder grpcBuilder() {
return OtlpGrpcMetricExporter.builder();
}

@Override
public void afterAutoConfigure(OpenTelemetrySdk sdk) {
meterProviderRef.set(sdk.getMeterProvider());
}
}
123 changes: 116 additions & 7 deletions ...src/test/java/io/opentelemetry/exporter/otlp/internal/OtlpMetricExporterProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,38 @@

package io.opentelemetry.exporter.otlp.internal;

import static java.util.Collections.emptyMap;
import static java.util.Collections.singletonMap;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;

import com.linecorp.armeria.testing.junit5.server.SelfSignedCertificateExtension;
import io.opentelemetry.api.metrics.MeterProvider;
import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter;
import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporterBuilder;
import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter;
import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporterBuilder;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
import io.opentelemetry.sdk.common.export.MemoryMode;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import java.io.IOException;
import java.lang.reflect.Field;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.cert.CertificateEncodingException;
import java.time.Duration;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Supplier;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
Expand Down Expand Up @@ -94,7 +101,7 @@ void createExporter_UnsupportedProtocol() {
() ->
provider.createExporter(
DefaultConfigProperties.createFromMap(
Collections.singletonMap("otel.exporter.otlp.protocol", "foo"))))
singletonMap("otel.exporter.otlp.protocol", "foo"))))
.isInstanceOf(ConfigurationException.class)
.hasMessageContaining("Unsupported OTLP metrics protocol: foo");
}
Expand All @@ -104,21 +111,21 @@ void createExporter_NoMocks() {
// Verifies createExporter after resetting the spy overrides
Mockito.reset(provider);
try (MetricExporter exporter =
provider.createExporter(DefaultConfigProperties.createFromMap(Collections.emptyMap()))) {
provider.createExporter(DefaultConfigProperties.createFromMap(emptyMap()))) {
assertThat(exporter).isInstanceOf(OtlpGrpcMetricExporter.class);
}
try (MetricExporter exporter =
provider.createExporter(
DefaultConfigProperties.createFromMap(
Collections.singletonMap("otel.exporter.otlp.protocol", "http/protobuf")))) {
singletonMap("otel.exporter.otlp.protocol", "http/protobuf")))) {
assertThat(exporter).isInstanceOf(OtlpHttpMetricExporter.class);
}
}

@Test
void createExporter_GrpcDefaults() {
try (MetricExporter exporter =
provider.createExporter(DefaultConfigProperties.createFromMap(Collections.emptyMap()))) {
provider.createExporter(DefaultConfigProperties.createFromMap(emptyMap()))) {
assertThat(exporter).isInstanceOf(OtlpGrpcMetricExporter.class);
verify(grpcBuilder, times(1)).build();
verify(grpcBuilder).setComponentLoader(any());
Expand Down Expand Up @@ -204,8 +211,7 @@ void createExporter_HttpDefaults() {
try (MetricExporter exporter =
provider.createExporter(
DefaultConfigProperties.createFromMap(
Collections.singletonMap(
"otel.exporter.otlp.metrics.protocol", "http/protobuf")))) {
singletonMap("otel.exporter.otlp.metrics.protocol", "http/protobuf")))) {
assertThat(exporter).isInstanceOf(OtlpHttpMetricExporter.class);
verify(httpBuilder, times(1)).build();
verify(httpBuilder).setComponentLoader(any());
Expand Down Expand Up @@ -288,4 +294,107 @@ void createExporter_HttpWithSignalConfiguration() throws CertificateEncodingExce
}
Mockito.verifyNoInteractions(grpcBuilder);
}

@Test
void meterProviderRef_InitializedWithNoop() throws Exception {
AtomicReference<MeterProvider> meterProviderRef = getMeterProviderRef(provider);

assertThat(meterProviderRef.get()).isSameAs(MeterProvider.noop());
}

@Test
void afterAutoConfigure_UpdatesMeterProviderRef() throws Exception {
OpenTelemetrySdk sdk = OpenTelemetrySdk.builder().build();

AtomicReference<MeterProvider> meterProviderRef = getMeterProviderRef(provider);
assertThat(meterProviderRef.get()).isSameAs(MeterProvider.noop());

provider.afterAutoConfigure(sdk);

assertThat(meterProviderRef.get()).isSameAs(sdk.getMeterProvider());
}

@Test
@SuppressWarnings("unchecked")
void createExporter_GrpcSetsMeterProviderSupplier() {
AtomicReference<Supplier<MeterProvider>> capturedSupplier = new AtomicReference<>();

OpenTelemetrySdk sdk = OpenTelemetrySdk.builder().build();
provider.afterAutoConfigure(sdk);

doAnswer(
invocation -> {
capturedSupplier.set(invocation.getArgument(0));
return grpcBuilder;
})
.when(grpcBuilder)
.setMeterProvider(any(Supplier.class));

try (MetricExporter exporter =
provider.createExporter(DefaultConfigProperties.createFromMap(emptyMap()))) {

assertThat(exporter).isInstanceOf(OtlpGrpcMetricExporter.class);
assertThat(capturedSupplier.get()).isNotNull();
assertThat(capturedSupplier.get().get()).isSameAs(sdk.getMeterProvider());
}
Mockito.verifyNoInteractions(httpBuilder);
}

@Test
@SuppressWarnings("unchecked")
void createExporter_HttpSetsMeterProviderSupplier() {
AtomicReference<Supplier<MeterProvider>> capturedSupplier = new AtomicReference<>();

OpenTelemetrySdk sdk = OpenTelemetrySdk.builder().build();
provider.afterAutoConfigure(sdk);

doAnswer(
invocation -> {
capturedSupplier.set(invocation.getArgument(0));
return httpBuilder;
})
.when(httpBuilder)
.setMeterProvider(any(Supplier.class));

try (MetricExporter exporter =
provider.createExporter(
DefaultConfigProperties.createFromMap(
singletonMap("otel.exporter.otlp.metrics.protocol", "http/protobuf")))) {

assertThat(exporter).isInstanceOf(OtlpHttpMetricExporter.class);
assertThat(capturedSupplier.get()).isNotNull();
assertThat(capturedSupplier.get().get()).isSameAs(sdk.getMeterProvider());
}
Mockito.verifyNoInteractions(grpcBuilder);
}

@Test
@SuppressWarnings("unchecked")
void meterProviderSupplier_ReturnsNoopBeforeAutoConfigure() {
AtomicReference<Supplier<MeterProvider>> capturedSupplier = new AtomicReference<>();

doAnswer(
invocation -> {
capturedSupplier.set(invocation.getArgument(0));
return grpcBuilder;
})
.when(grpcBuilder)
.setMeterProvider(any(Supplier.class));

try (MetricExporter exporter =
provider.createExporter(DefaultConfigProperties.createFromMap(emptyMap()))) {

assertThat(exporter).isInstanceOf(OtlpGrpcMetricExporter.class);
assertThat(capturedSupplier.get()).isNotNull();
assertThat(capturedSupplier.get().get()).isSameAs(MeterProvider.noop());
}
}

@SuppressWarnings("unchecked")
private static AtomicReference<MeterProvider> getMeterProviderRef(
OtlpMetricExporterProvider provider) throws Exception {
Field field = OtlpMetricExporterProvider.class.getDeclaredField("meterProviderRef");
field.setAccessible(true);
return (AtomicReference<MeterProvider>) field.get(provider);
}
}
4 changes: 3 additions & 1 deletion ...estFullConfig/java/io/opentelemetry/sdk/autoconfigure/ConfigurableMetricExporterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

import com.google.common.collect.ImmutableMap;
import io.opentelemetry.exporter.logging.LoggingMetricExporter;
import io.opentelemetry.exporter.otlp.internal.OtlpMetricExporterProvider;
import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter;
import io.opentelemetry.internal.testing.CleanupExtension;
import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
Expand Down Expand Up @@ -52,7 +53,8 @@ void configureExporter_spiExporter() {
assertThat(spiHelper.getListeners())
.satisfiesExactlyInAnyOrder(
listener ->
assertThat(listener).isInstanceOf(TestConfigurableMetricExporterProvider.class));
assertThat(listener).isInstanceOf(TestConfigurableMetricExporterProvider.class),
listener -> assertThat(listener).isInstanceOf(OtlpMetricExporterProvider.class));
}
}

Expand Down
Loading