Class OpenTelemetryMetricsModule

java.lang.Object

io.grpc.opentelemetry.OpenTelemetryMetricsModule

final class OpenTelemetryMetricsModule
extends Object

Provides factories for StreamTracer that records metrics to OpenTelemetry.

On the client-side, a factory is created for each call, and the factory creates a stream tracer for each attempt. If there is no stream created when the call is ended, we still create a tracer. It's the tracer that reports per-attempt stats, and the factory that reports the stats of the overall RPC, such as RETRIES_PER_CALL, to OpenTelemetry.

On the server-side, there is only one ServerStream per each ServerCall, and ServerStream starts earlier than the ServerCall. Therefore, only one tracer is created per stream/call, and it's the tracer that reports the summary to OpenTelemetry.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	OpenTelemetryMetricsModule.CallAttemptsTracerFactory
private static final class	OpenTelemetryMetricsModule.ClientTracer
(package private) final class	OpenTelemetryMetricsModule.MetricsClientInterceptor
private static final class	OpenTelemetryMetricsModule.ServerTracer
(package private) final class	OpenTelemetryMetricsModule.ServerTracerFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final com.google.common.collect.ImmutableSet<String>	DEFAULT_PER_CALL_METRICS_SET
private static final String	LOCALITY_LABEL_NAME
private final boolean	localityEnabled
private static final Logger	logger
private final com.google.common.collect.ImmutableList<OpenTelemetryPlugin>	plugins
private final OpenTelemetryMetricsResource	resource
private static final double	SECONDS_PER_NANO
private final com.google.common.base.Supplier<com.google.common.base.Stopwatch>	stopwatchSupplier

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryMetricsModule(com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchSupplier, OpenTelemetryMetricsResource resource, Collection<String> optionalLabels, List<OpenTelemetryPlugin> plugins)

Method Summary

Modifier and Type	Method	Description
(package private) io.grpc.ClientInterceptor	getClientInterceptor(String target)	Returns the client interceptor that facilitates OpenTelemetry metrics reporting.
(package private) io.grpc.ServerStreamTracer.Factory	getServerTracerFactory()	Returns the server tracer factory.
(package private) static String	recordMethodName(String fullMethodName, boolean isGeneratedMethod)

Methods inherited from class Object

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

Field Details

logger

private static final Logger logger

LOCALITY_LABEL_NAME

private static final String LOCALITY_LABEL_NAME

See Also:

• Constant Field Values

DEFAULT_PER_CALL_METRICS_SET

public static final com.google.common.collect.ImmutableSet<String> DEFAULT_PER_CALL_METRICS_SET

SECONDS_PER_NANO

private static final double SECONDS_PER_NANO

See Also:

• Constant Field Values

resource

private final OpenTelemetryMetricsResource resource

stopwatchSupplier

private final com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchSupplier

localityEnabled

private final boolean localityEnabled

plugins

private final com.google.common.collect.ImmutableList<OpenTelemetryPlugin> plugins

Constructor Details

OpenTelemetryMetricsModule

OpenTelemetryMetricsModule(com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchSupplier,
 OpenTelemetryMetricsResource resource,
 Collection<String> optionalLabels,
 List<OpenTelemetryPlugin> plugins)

Method Details

getServerTracerFactory

io.grpc.ServerStreamTracer.Factory getServerTracerFactory()

Returns the server tracer factory.

getClientInterceptor

io.grpc.ClientInterceptor getClientInterceptor(String target)

Returns the client interceptor that facilitates OpenTelemetry metrics reporting.

recordMethodName

static String recordMethodName(String fullMethodName,
 boolean isGeneratedMethod)