io.opentracing.contrib.grpc

Class TracingServerInterceptor.Builder

java.lang.Object

io.opentracing.contrib.grpc.TracingServerInterceptor.Builder

Enclosing class:

TracingServerInterceptor

public static class TracingServerInterceptor.Builder
extends Object

Builds the configuration of a TracingServerInterceptor.

Method Summary

Modifier and Type	Method and Description
TracingServerInterceptor	build() Build the TracingServerInterceptor.
TracingServerInterceptor.Builder	withOperationName(OperationNameConstructor operationNameConstructor) Provide operation name.
TracingServerInterceptor.Builder	withServerCloseDecorator(ServerCloseDecorator serverCloseDecorator) Decorates the server span with custom data when the gRPC call is closed.
TracingServerInterceptor.Builder	withServerSpanDecorator(ServerSpanDecorator serverSpanDecorator) Decorates the server span with custom data.
TracingServerInterceptor.Builder	withStreaming() Logs streaming events to server spans.
TracingServerInterceptor.Builder	withTracedAttributes(TracingServerInterceptor.ServerRequestAttribute... attributes) Provide traced attributes.
TracingServerInterceptor.Builder	withTracer(io.opentracing.Tracer tracer) Provide the Tracer.
TracingServerInterceptor.Builder	withVerbosity() Logs all request life-cycle events to server spans.

Methods inherited from class java.lang.Object

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

Method Detail

withTracer

public TracingServerInterceptor.Builder withTracer(io.opentracing.Tracer tracer)

Provide the Tracer.

Parameters:

tracer - the tracer

Returns:

this Builder with configured tracer

withOperationName

public TracingServerInterceptor.Builder withOperationName(OperationNameConstructor operationNameConstructor)

Provide operation name.

Parameters:

operationNameConstructor - for all spans created by this interceptor

Returns:

this Builder with configured operation name

withTracedAttributes

public TracingServerInterceptor.Builder withTracedAttributes(TracingServerInterceptor.ServerRequestAttribute... attributes)

Provide traced attributes.

Parameters:

attributes - to set as tags on server spans created by this interceptor

Returns:

this Builder configured to trace request attributes

withStreaming

public TracingServerInterceptor.Builder withStreaming()

Logs streaming events to server spans.

Returns:

this Builder configured to log streaming events

withVerbosity

public TracingServerInterceptor.Builder withVerbosity()

Logs all request life-cycle events to server spans.

Returns:

this Builder configured to be verbose

withServerSpanDecorator

public TracingServerInterceptor.Builder withServerSpanDecorator(ServerSpanDecorator serverSpanDecorator)

Decorates the server span with custom data.

Parameters:

serverSpanDecorator - used to decorate the server span

Returns:

this Builder configured to decorate server span

withServerCloseDecorator

public TracingServerInterceptor.Builder withServerCloseDecorator(ServerCloseDecorator serverCloseDecorator)

Decorates the server span with custom data when the gRPC call is closed.

Parameters:

serverCloseDecorator - used to decorate the server span

Returns:

this Builder configured to decorate server span when the gRPC call is closed

build

public TracingServerInterceptor build()

Build the TracingServerInterceptor.

Returns:

a TracingServerInterceptor with this Builder's configuration