Package io.grpc.opentelemetry
Class GrpcOpenTelemetry
- java.lang.Object
-
- io.grpc.opentelemetry.GrpcOpenTelemetry
-
public final class GrpcOpenTelemetry extends Object
The entrypoint for OpenTelemetry metrics functionality in gRPC.GrpcOpenTelemetry uses
OpenTelemetryAPIs for instrumentation. When no SDK is explicitly added no telemetry data will be collected. Seeio.opentelemetry.sdk.OpenTelemetrySdkfor information on how to construct the SDK.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGrpcOpenTelemetry.BuilderBuilder for configuringGrpcOpenTelemetry.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidconfigureChannelBuilder(ManagedChannelBuilder<?> builder)Configures the givenManagedChannelBuilderwith OpenTelemetry metrics instrumentation.voidconfigureServerBuilder(ServerBuilder<?> serverBuilder)Configures the givenServerBuilderwith OpenTelemetry metrics instrumentation.static GrpcOpenTelemetry.BuildernewBuilder()voidregisterGlobal()Registers GrpcOpenTelemetry globally, applying its configuration to all subsequently created gRPC channels and servers.
-
-
-
Method Detail
-
newBuilder
public static GrpcOpenTelemetry.Builder newBuilder()
-
registerGlobal
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/10591") public void registerGlobal()
Registers GrpcOpenTelemetry globally, applying its configuration to all subsequently created gRPC channels and servers.
-
configureChannelBuilder
public void configureChannelBuilder(ManagedChannelBuilder<?> builder)
Configures the givenManagedChannelBuilderwith OpenTelemetry metrics instrumentation.
-
configureServerBuilder
public void configureServerBuilder(ServerBuilder<?> serverBuilder)
Configures the givenServerBuilderwith OpenTelemetry metrics instrumentation.- Parameters:
serverBuilder- the server builder to configure
-
-