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 OpenTelemetry APIs for instrumentation. When no SDK is explicitly added no telemetry data will be collected. See io.opentelemetry.sdk.OpenTelemetrySdk for information on how to construct the SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GrpcOpenTelemetry.Builder	Builder for configuring GrpcOpenTelemetry.

Method Summary

Modifier and Type	Method	Description
void	configureChannelBuilder(io.grpc.ManagedChannelBuilder<?> builder)	Configures the given ManagedChannelBuilder with OpenTelemetry metrics instrumentation.
void	configureServerBuilder(io.grpc.ServerBuilder<?> serverBuilder)	Configures the given ServerBuilder with OpenTelemetry metrics instrumentation.
static GrpcOpenTelemetry.Builder	newBuilder()
void	registerGlobal()	Registers GrpcOpenTelemetry globally, applying its configuration to all subsequently created gRPC channels and servers.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

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(io.grpc.ManagedChannelBuilder<?> builder)

Configures the given ManagedChannelBuilder with OpenTelemetry metrics instrumentation.

configureServerBuilder

public void configureServerBuilder(io.grpc.ServerBuilder<?> serverBuilder)

Configures the given ServerBuilder with OpenTelemetry metrics instrumentation.

Parameters:

serverBuilder - the server builder to configure