Class OpenTelemetryTracingModule

java.lang.Object

io.grpc.opentelemetry.OpenTelemetryTracingModule

final class OpenTelemetryTracingModule
extends Object

Provides factories for StreamTracer that records tracing to OpenTelemetry.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) final class	OpenTelemetryTracingModule.CallAttemptsTracerFactory
private final class	OpenTelemetryTracingModule.ClientTracer
private static class	OpenTelemetryTracingModule.ContextServerCallListener<ReqT>
private final class	OpenTelemetryTracingModule.ServerTracer
(package private) final class	OpenTelemetryTracingModule.ServerTracerFactory
(package private) final class	OpenTelemetryTracingModule.TracingClientInterceptor
(package private) final class	OpenTelemetryTracingModule.TracingServerSpanPropagationInterceptor

Field Summary

Fields

Modifier and Type	Field	Description
private static final AtomicIntegerFieldUpdater<OpenTelemetryTracingModule.CallAttemptsTracerFactory>	callEndedUpdater
private final OpenTelemetryTracingModule.TracingClientInterceptor	clientInterceptor
private final io.opentelemetry.context.propagation.ContextPropagators	contextPropagators
private static final Logger	logger
private final MetadataGetter	metadataGetter
private final MetadataSetter	metadataSetter
(package private) final io.grpc.Context.Key<io.opentelemetry.api.trace.Span>	otelSpan
private final io.opentelemetry.api.trace.Tracer	otelTracer
private final io.grpc.ServerInterceptor	serverSpanPropagationInterceptor
private final OpenTelemetryTracingModule.ServerTracerFactory	serverTracerFactory
private static final AtomicIntegerFieldUpdater<OpenTelemetryTracingModule.ServerTracer>	streamClosedUpdater

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryTracingModule(io.opentelemetry.api.OpenTelemetry openTelemetry)

Method Summary

Modifier and Type	Method	Description
private void	endSpanWithStatus(io.opentelemetry.api.trace.Span span, io.grpc.Status status)
private String	generateErrorStatusDescription(io.grpc.Status status)
(package private) static String	generateTraceSpanName(boolean isServer, String fullMethodName)	Convert a full method name to a tracing span name.
(package private) io.grpc.ClientInterceptor	getClientInterceptor()	Returns the client interceptor that facilitates otel tracing reporting.
(package private) io.grpc.ServerInterceptor	getServerSpanPropagationInterceptor()
(package private) io.grpc.ServerStreamTracer.Factory	getServerTracerFactory()	Returns the server tracer factory.
(package private) io.opentelemetry.api.trace.Tracer	getTracer()
(package private) OpenTelemetryTracingModule.CallAttemptsTracerFactory	newClientCallTracer(io.opentelemetry.api.trace.Span clientSpan, io.grpc.MethodDescriptor<?,?> method)	Creates a OpenTelemetryTracingModule.CallAttemptsTracerFactory for a new call.
private void	recordInboundCompressedMessage(io.opentelemetry.api.trace.Span span, int seqNo, long optionalWireSize)
private void	recordInboundMessageSize(io.opentelemetry.api.trace.Span span, int seqNo, long bytes)
private void	recordOutboundMessageSentEvent(io.opentelemetry.api.trace.Span span, int seqNo, long optionalWireSize, long optionalUncompressedSize)

Methods inherited from class Object

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

Field Details

logger

private static final Logger logger

otelSpan

final io.grpc.Context.Key<io.opentelemetry.api.trace.Span> otelSpan

callEndedUpdater

@Nullable
private static final AtomicIntegerFieldUpdater<OpenTelemetryTracingModule.CallAttemptsTracerFactory> callEndedUpdater

streamClosedUpdater

@Nullable
private static final AtomicIntegerFieldUpdater<OpenTelemetryTracingModule.ServerTracer> streamClosedUpdater

otelTracer

private final io.opentelemetry.api.trace.Tracer otelTracer

contextPropagators

private final io.opentelemetry.context.propagation.ContextPropagators contextPropagators

metadataGetter

private final MetadataGetter metadataGetter

metadataSetter

private final MetadataSetter metadataSetter

clientInterceptor

private final OpenTelemetryTracingModule.TracingClientInterceptor clientInterceptor

serverSpanPropagationInterceptor

private final io.grpc.ServerInterceptor serverSpanPropagationInterceptor

serverTracerFactory

private final OpenTelemetryTracingModule.ServerTracerFactory serverTracerFactory

Constructor Details

OpenTelemetryTracingModule

OpenTelemetryTracingModule(io.opentelemetry.api.OpenTelemetry openTelemetry)

Method Details

getTracer

io.opentelemetry.api.trace.Tracer getTracer()

newClientCallTracer

OpenTelemetryTracingModule.CallAttemptsTracerFactory newClientCallTracer(io.opentelemetry.api.trace.Span clientSpan,
 io.grpc.MethodDescriptor<?,?> method)

Creates a OpenTelemetryTracingModule.CallAttemptsTracerFactory for a new call.

getServerTracerFactory

io.grpc.ServerStreamTracer.Factory getServerTracerFactory()

Returns the server tracer factory.

getClientInterceptor

io.grpc.ClientInterceptor getClientInterceptor()

Returns the client interceptor that facilitates otel tracing reporting.

getServerSpanPropagationInterceptor

io.grpc.ServerInterceptor getServerSpanPropagationInterceptor()

recordOutboundMessageSentEvent

private void recordOutboundMessageSentEvent(io.opentelemetry.api.trace.Span span,
 int seqNo,
 long optionalWireSize,
 long optionalUncompressedSize)

recordInboundCompressedMessage

private void recordInboundCompressedMessage(io.opentelemetry.api.trace.Span span,
 int seqNo,
 long optionalWireSize)

recordInboundMessageSize

private void recordInboundMessageSize(io.opentelemetry.api.trace.Span span,
 int seqNo,
 long bytes)

generateErrorStatusDescription

private String generateErrorStatusDescription(io.grpc.Status status)

endSpanWithStatus

private void endSpanWithStatus(io.opentelemetry.api.trace.Span span,
 io.grpc.Status status)

generateTraceSpanName

static String generateTraceSpanName(boolean isServer,
 String fullMethodName)

Convert a full method name to a tracing span name.

Parameters:

isServer - false if the span is on the client-side, true if on the server-side

fullMethodName - the method name as returned by MethodDescriptor.getFullMethodName().