io.opentracing.contrib.grpc

Class TracingClientInterceptor.Builder

java.lang.Object

io.opentracing.contrib.grpc.TracingClientInterceptor.Builder

Enclosing class:

TracingClientInterceptor

public static class TracingClientInterceptor.Builder
extends Object

Builds the configuration of a TracingClientInterceptor.

Constructor Summary

Constructors

Constructor and Description
Builder() Creates a Builder with GlobalTracer if present else NoopTracer.

Method Summary

Modifier and Type	Method and Description
TracingClientInterceptor	build() Build the TracingClientInterceptor.
TracingClientInterceptor.Builder	withActiveSpanContextSource(ActiveSpanContextSource activeSpanContextSource) Provide the active span context source.
TracingClientInterceptor.Builder	withActiveSpanSource(ActiveSpanSource activeSpanSource) Provide the active span source.
TracingClientInterceptor.Builder	withClientCloseDecorator(ClientCloseDecorator clientCloseDecorator) Decorates the client span with custom data when the call is closed.
TracingClientInterceptor.Builder	withClientSpanDecorator(ClientSpanDecorator clientSpanDecorator) Decorates the client span with custom data.
TracingClientInterceptor.Builder	withOperationName(OperationNameConstructor operationNameConstructor) Provide operation name constructor.
TracingClientInterceptor.Builder	withStreaming() Logs streaming events to client spans.
TracingClientInterceptor.Builder	withTracedAttributes(TracingClientInterceptor.ClientRequestAttribute... tracedAttributes) Provide traced attributes.
TracingClientInterceptor.Builder	withTracer(io.opentracing.Tracer tracer) Provide the Tracer.
TracingClientInterceptor.Builder	withVerbosity() Logs all request life-cycle events to client spans.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a Builder with GlobalTracer if present else NoopTracer.

Method Detail

withTracer

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

Provide the Tracer.

Parameters:

tracer - the tracer

Returns:

this Builder with configured tracer

withOperationName

public TracingClientInterceptor.Builder withOperationName(OperationNameConstructor operationNameConstructor)

Provide operation name constructor.

Parameters:

operationNameConstructor - to name all spans created by this interceptor

Returns:

this Builder with configured operation name

withStreaming

public TracingClientInterceptor.Builder withStreaming()

Logs streaming events to client spans.

Returns:

this Builder configured to log streaming events

withTracedAttributes

public TracingClientInterceptor.Builder withTracedAttributes(TracingClientInterceptor.ClientRequestAttribute... tracedAttributes)

Provide traced attributes.

Parameters:

tracedAttributes - to set as tags on client spans created by this interceptor

Returns:

this Builder configured to trace attributes

withVerbosity

public TracingClientInterceptor.Builder withVerbosity()

Logs all request life-cycle events to client spans.

Returns:

this Builder configured to be verbose

withActiveSpanSource

public TracingClientInterceptor.Builder withActiveSpanSource(ActiveSpanSource activeSpanSource)

Provide the active span source.

Parameters:

activeSpanSource - that provides a method of getting the active span before the client call

Returns:

this Builder configured to start client span as children of the span returned by activeSpanSource.getActiveSpan()

withActiveSpanContextSource

public TracingClientInterceptor.Builder withActiveSpanContextSource(ActiveSpanContextSource activeSpanContextSource)

Provide the active span context source.

Parameters:

activeSpanContextSource - that provides a method of getting the active span context before the client call

Returns:

this Builder configured to start client span as children of the span context returned by activeSpanContextSource.getActiveSpanContext()

withClientSpanDecorator

public TracingClientInterceptor.Builder withClientSpanDecorator(ClientSpanDecorator clientSpanDecorator)

Decorates the client span with custom data.

Parameters:

clientSpanDecorator - used to decorate the client span

Returns:

this builder configured to decorate the client span

withClientCloseDecorator

public TracingClientInterceptor.Builder withClientCloseDecorator(ClientCloseDecorator clientCloseDecorator)

Decorates the client span with custom data when the call is closed.

Parameters:

clientCloseDecorator - used to decorate the client span when the call is closed

Returns:

this builder configured to decorate the client span when the call is closed

build

public TracingClientInterceptor build()

Build the TracingClientInterceptor.

Returns:

a TracingClientInterceptor with this Builder's configuration