flasn4nt
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

opentelemetry: Rename and stabilize API OpenTelemetryModule 

OpenTelemetryModule is renamed to GrpcOpenTelemetry. The Builder is now
`final`, although that should only impact mocks as it had a private
constructor.

Fixes #10591
This commit is contained in:
Eric Anderson 2024-05-08 07:51:17 -07:00
parent 8808d63338
commit 1e731be49a
3 changed files with 24 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
opentelemetry/src/main/java/io/grpc/opentelemetry/OpenTelemetryModule.java → opentelemetry/src/main/java/io/grpc/opentelemetry/GrpcOpenTelemetry.java
View File

@ -24,7 +24,6 @@ import com.google.common.base.Stopwatch;
import com.google.common.base.Supplier; import com.google.common.base.Supplier;
import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableMap;
import io.grpc.ExperimentalApi;
import io.grpc.InternalConfigurator; import io.grpc.InternalConfigurator;
import io.grpc.InternalConfiguratorRegistry; import io.grpc.InternalConfiguratorRegistry;
import io.grpc.InternalManagedChannelBuilder; import io.grpc.InternalManagedChannelBuilder;
@ -45,13 +44,12 @@ import java.util.Map;
/** /**
* The entrypoint for OpenTelemetry metrics functionality in gRPC. * The entrypoint for OpenTelemetry metrics functionality in gRPC.
* *
* <p>OpenTelemetryModule uses {@link io.opentelemetry.api.OpenTelemetry} APIs for instrumentation. * <p>GrpcOpenTelemetry uses {@link io.opentelemetry.api.OpenTelemetry} APIs for instrumentation.
* When no SDK is explicitly added no telemetry data will be collected. See * When no SDK is explicitly added no telemetry data will be collected. See
* {@link io.opentelemetry.sdk.OpenTelemetrySdk} for information on how to construct the SDK. * {@link io.opentelemetry.sdk.OpenTelemetrySdk} for information on how to construct the SDK.
* *
*/ */
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/10591") public final class GrpcOpenTelemetry {
public final class OpenTelemetryModule {
private static final Supplier<Stopwatch> STOPWATCH_SUPPLIER = new Supplier<Stopwatch>() { private static final Supplier<Stopwatch> STOPWATCH_SUPPLIER = new Supplier<Stopwatch>() {
@Override @Override
@ -74,7 +72,7 @@ public final class OpenTelemetryModule {
return new Builder(); return new Builder();
} }
private OpenTelemetryModule(Builder builder) { private GrpcOpenTelemetry(Builder builder) {
this.openTelemetrySdk = checkNotNull(builder.openTelemetrySdk, "openTelemetrySdk"); this.openTelemetrySdk = checkNotNull(builder.openTelemetrySdk, "openTelemetrySdk");
this.meterProvider = checkNotNull(openTelemetrySdk.getMeterProvider(), "meterProvider"); this.meterProvider = checkNotNull(openTelemetrySdk.getMeterProvider(), "meterProvider");
this.meter = this.meterProvider this.meter = this.meterProvider
@ -125,7 +123,7 @@ public final class OpenTelemetryModule {
} }
/** /**
* Registers OpenTelemetryModule globally, applying its configuration to all subsequently created * Registers GrpcOpenTelemetry globally, applying its configuration to all subsequently created
* gRPC channels and servers. * gRPC channels and servers.
*/ */
public void registerGlobal() { public void registerGlobal() {
@ -133,12 +131,12 @@ public final class OpenTelemetryModule {
new InternalConfigurator() { new InternalConfigurator() {
@Override @Override
public void configureChannelBuilder(ManagedChannelBuilder<?> channelBuilder) { public void configureChannelBuilder(ManagedChannelBuilder<?> channelBuilder) {
OpenTelemetryModule.this.configureChannelBuilder(channelBuilder); GrpcOpenTelemetry.this.configureChannelBuilder(channelBuilder);
} }
@Override @Override
public void configureServerBuilder(ServerBuilder<?> serverBuilder) { public void configureServerBuilder(ServerBuilder<?> serverBuilder) {
OpenTelemetryModule.this.configureServerBuilder(serverBuilder); GrpcOpenTelemetry.this.configureServerBuilder(serverBuilder);
} }
})); }));
} }
@ -268,7 +266,7 @@ public final class OpenTelemetryModule {
/** /**
* Builder for configuring {@link OpenTelemetryModule}. * Builder for configuring {@link GrpcOpenTelemetry}.
*/ */
public static class Builder { public static class Builder {
private OpenTelemetry openTelemetrySdk = OpenTelemetry.noop(); private OpenTelemetry openTelemetrySdk = OpenTelemetry.noop();
@ -328,11 +326,11 @@ public final class OpenTelemetryModule {
} }
/** /**
* Returns a new {@link OpenTelemetryModule} built with the configuration of this {@link * Returns a new {@link GrpcOpenTelemetry} built with the configuration of this {@link
* Builder}. * Builder}.
*/ */
public OpenTelemetryModule build() { public GrpcOpenTelemetry build() {
return new OpenTelemetryModule(this); return new GrpcOpenTelemetry(this);
} }
} }
} }

14
opentelemetry/src/test/java/io/grpc/opentelemetry/OpenTelemetryModuleTest.java → opentelemetry/src/test/java/io/grpc/opentelemetry/GrpcOpenTelemetryTest.java
View File

@ -31,7 +31,7 @@ import org.junit.runner.RunWith;
import org.junit.runners.JUnit4; import org.junit.runners.JUnit4;
@RunWith(JUnit4.class) @RunWith(JUnit4.class)
public class OpenTelemetryModuleTest { public class GrpcOpenTelemetryTest {
private final InMemoryMetricReader inMemoryMetricReader = InMemoryMetricReader.create(); private final InMemoryMetricReader inMemoryMetricReader = InMemoryMetricReader.create();
private final SdkMeterProvider meterProvider = private final SdkMeterProvider meterProvider =
SdkMeterProvider.builder().registerMetricReader(inMemoryMetricReader).build(); SdkMeterProvider.builder().registerMetricReader(inMemoryMetricReader).build();
@ -42,7 +42,7 @@ public class OpenTelemetryModuleTest {
OpenTelemetrySdk sdk = OpenTelemetrySdk sdk =
OpenTelemetrySdk.builder().setMeterProvider(meterProvider).build(); OpenTelemetrySdk.builder().setMeterProvider(meterProvider).build();
OpenTelemetryModule openTelemetryModule = OpenTelemetryModule.newBuilder() GrpcOpenTelemetry openTelemetryModule = GrpcOpenTelemetry.newBuilder()
.sdk(sdk) .sdk(sdk)
.addOptionalLabel("version") .addOptionalLabel("version")
.build(); .build();
@ -58,7 +58,7 @@ public class OpenTelemetryModuleTest {
@Test @Test
public void builderDefaults() { public void builderDefaults() {
OpenTelemetryModule module = OpenTelemetryModule.newBuilder().build(); GrpcOpenTelemetry module = GrpcOpenTelemetry.newBuilder().build();
assertThat(module.getOpenTelemetryInstance()).isNotNull(); assertThat(module.getOpenTelemetryInstance()).isNotNull();
assertThat(module.getOpenTelemetryInstance()).isSameInstanceAs(noopOpenTelemetry); assertThat(module.getOpenTelemetryInstance()).isSameInstanceAs(noopOpenTelemetry);
@ -77,11 +77,11 @@ public class OpenTelemetryModuleTest {
@Test @Test
public void enableDisableMetrics() { public void enableDisableMetrics() {
OpenTelemetryModule.Builder builder = OpenTelemetryModule.newBuilder(); GrpcOpenTelemetry.Builder builder = GrpcOpenTelemetry.newBuilder();
builder.enableMetrics(Arrays.asList("metric1", "metric4")); builder.enableMetrics(Arrays.asList("metric1", "metric4"));
builder.disableMetrics(Arrays.asList("metric2", "metric3")); builder.disableMetrics(Arrays.asList("metric2", "metric3"));
OpenTelemetryModule module = builder.build(); GrpcOpenTelemetry module = builder.build();
assertThat(module.getEnableMetrics().get("metric1")).isTrue(); assertThat(module.getEnableMetrics().get("metric1")).isTrue();
assertThat(module.getEnableMetrics().get("metric4")).isTrue(); assertThat(module.getEnableMetrics().get("metric4")).isTrue();
@ -91,12 +91,12 @@ public class OpenTelemetryModuleTest {
@Test @Test
public void disableAllMetrics() { public void disableAllMetrics() {
OpenTelemetryModule.Builder builder = OpenTelemetryModule.newBuilder(); GrpcOpenTelemetry.Builder builder = GrpcOpenTelemetry.newBuilder();
builder.enableMetrics(Arrays.asList("metric1", "metric4")); builder.enableMetrics(Arrays.asList("metric1", "metric4"));
builder.disableMetrics(Arrays.asList("metric2", "metric3")); builder.disableMetrics(Arrays.asList("metric2", "metric3"));
builder.disableAllMetrics(); builder.disableAllMetrics();
OpenTelemetryModule module = builder.build(); GrpcOpenTelemetry module = builder.build();
assertThat(module.getEnableMetrics()).isEmpty(); assertThat(module.getEnableMetrics()).isEmpty();
} }

14
opentelemetry/src/test/java/io/grpc/opentelemetry/OpenTelemetryMetricsModuleTest.java
View File

@ -158,7 +158,7 @@ public class OpenTelemetryMetricsModuleTest {
@Test @Test
public void testClientInterceptors() { public void testClientInterceptors() {
OpenTelemetryMetricsResource resource = OpenTelemetryModule.createMetricInstruments(testMeter, OpenTelemetryMetricsResource resource = GrpcOpenTelemetry.createMetricInstruments(testMeter,
enabledMetricsMap, disableDefaultMetrics); enabledMetricsMap, disableDefaultMetrics);
OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource); OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource);
grpcServerRule.getServiceRegistry().addService( grpcServerRule.getServiceRegistry().addService(
@ -214,7 +214,7 @@ public class OpenTelemetryMetricsModuleTest {
@Test @Test
public void clientBasicMetrics() { public void clientBasicMetrics() {
String target = "target:///"; String target = "target:///";
OpenTelemetryMetricsResource resource = OpenTelemetryModule.createMetricInstruments(testMeter, OpenTelemetryMetricsResource resource = GrpcOpenTelemetry.createMetricInstruments(testMeter,
enabledMetricsMap, disableDefaultMetrics); enabledMetricsMap, disableDefaultMetrics);
OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource); OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource);
OpenTelemetryMetricsModule.CallAttemptsTracerFactory callAttemptsTracerFactory = OpenTelemetryMetricsModule.CallAttemptsTracerFactory callAttemptsTracerFactory =
@ -353,7 +353,7 @@ public class OpenTelemetryMetricsModuleTest {
@Test @Test
public void recordAttemptMetrics() { public void recordAttemptMetrics() {
String target = "dns:///example.com"; String target = "dns:///example.com";
OpenTelemetryMetricsResource resource = OpenTelemetryModule.createMetricInstruments(testMeter, OpenTelemetryMetricsResource resource = GrpcOpenTelemetry.createMetricInstruments(testMeter,
enabledMetricsMap, disableDefaultMetrics); enabledMetricsMap, disableDefaultMetrics);
OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource); OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource);
OpenTelemetryMetricsModule.CallAttemptsTracerFactory callAttemptsTracerFactory = OpenTelemetryMetricsModule.CallAttemptsTracerFactory callAttemptsTracerFactory =
@ -778,7 +778,7 @@ public class OpenTelemetryMetricsModuleTest {
@Test @Test
public void clientStreamNeverCreatedStillRecordMetrics() { public void clientStreamNeverCreatedStillRecordMetrics() {
String target = "dns:///foo.example.com"; String target = "dns:///foo.example.com";
OpenTelemetryMetricsResource resource = OpenTelemetryModule.createMetricInstruments(testMeter, OpenTelemetryMetricsResource resource = GrpcOpenTelemetry.createMetricInstruments(testMeter,
enabledMetricsMap, disableDefaultMetrics); enabledMetricsMap, disableDefaultMetrics);
OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource); OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource);
OpenTelemetryMetricsModule.CallAttemptsTracerFactory callAttemptsTracerFactory = OpenTelemetryMetricsModule.CallAttemptsTracerFactory callAttemptsTracerFactory =
@ -882,7 +882,7 @@ public class OpenTelemetryMetricsModuleTest {
@Test @Test
public void clientLocalityMetrics_present() { public void clientLocalityMetrics_present() {
String target = "target:///"; String target = "target:///";
OpenTelemetryMetricsResource resource = OpenTelemetryModule.createMetricInstruments(testMeter, OpenTelemetryMetricsResource resource = GrpcOpenTelemetry.createMetricInstruments(testMeter,
enabledMetricsMap, disableDefaultMetrics); enabledMetricsMap, disableDefaultMetrics);
OpenTelemetryMetricsModule module = new OpenTelemetryMetricsModule( OpenTelemetryMetricsModule module = new OpenTelemetryMetricsModule(
fakeClock.getStopwatchSupplier(), resource, Arrays.asList("grpc.lb.locality")); fakeClock.getStopwatchSupplier(), resource, Arrays.asList("grpc.lb.locality"));
@ -950,7 +950,7 @@ public class OpenTelemetryMetricsModuleTest {
@Test @Test
public void clientLocalityMetrics_missing() { public void clientLocalityMetrics_missing() {
String target = "target:///"; String target = "target:///";
OpenTelemetryMetricsResource resource = OpenTelemetryModule.createMetricInstruments(testMeter, OpenTelemetryMetricsResource resource = GrpcOpenTelemetry.createMetricInstruments(testMeter,
enabledMetricsMap, disableDefaultMetrics); enabledMetricsMap, disableDefaultMetrics);
OpenTelemetryMetricsModule module = new OpenTelemetryMetricsModule( OpenTelemetryMetricsModule module = new OpenTelemetryMetricsModule(
fakeClock.getStopwatchSupplier(), resource, Arrays.asList("grpc.lb.locality")); fakeClock.getStopwatchSupplier(), resource, Arrays.asList("grpc.lb.locality"));
@ -1013,7 +1013,7 @@ public class OpenTelemetryMetricsModuleTest {
@Test @Test
public void serverBasicMetrics() { public void serverBasicMetrics() {
OpenTelemetryMetricsResource resource = OpenTelemetryModule.createMetricInstruments(testMeter, OpenTelemetryMetricsResource resource = GrpcOpenTelemetry.createMetricInstruments(testMeter,
enabledMetricsMap, disableDefaultMetrics); enabledMetricsMap, disableDefaultMetrics);
OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource); OpenTelemetryMetricsModule module = newOpenTelemetryMetricsModule(resource);
ServerStreamTracer.Factory tracerFactory = module.getServerTracerFactory(); ServerStreamTracer.Factory tracerFactory = module.getServerTracerFactory();