Package io.smallrye.opentracing.contrib.jaxrs2.server

Class ServerTracingDynamicFeature.Builder

java.lang.Object

io.smallrye.opentracing.contrib.jaxrs2.server.ServerTracingDynamicFeature.Builder

Enclosing class:

ServerTracingDynamicFeature

public static class ServerTracingDynamicFeature.Builder
extends Object

Builder for creating JAX-RS dynamic feature for tracing server requests. By default span's operation name is HTTP method and span is decorated with ServerSpanDecorator.STANDARD_TAGS which adds standard tags. If you want to set different span name provide custom span decorator ServerSpanDecorator.

Constructor Summary

Constructors

Constructor	Description
Builder(io.opentracing.Tracer tracer)

Method Summary

Modifier and Type	Method	Description
ServerTracingDynamicFeature	build()
ServerTracingDynamicFeature.Builder	withDecorators(List<ServerSpanDecorator> spanDecorators)	Set span decorators.
ServerTracingDynamicFeature.Builder	withJoinExistingActiveSpan(boolean joinExistingActiveSpan)
ServerTracingDynamicFeature.Builder	withOperationNameProvider(OperationNameProvider.Builder builder)
ServerTracingDynamicFeature.Builder	withPriority(int priority)
ServerTracingDynamicFeature.Builder	withSerializationDecorators(List<InterceptorSpanDecorator> spanDecorators)	Set serialization span decorators.
ServerTracingDynamicFeature.Builder	withSerializationPriority(int serializationPriority)
ServerTracingDynamicFeature.Builder	withSkipPattern(String skipPattern)
ServerTracingDynamicFeature.Builder	withTraceNothing()	Only resources annotated with Traced will be traced.
ServerTracingDynamicFeature.Builder	withTraceSerialization(boolean traceSerialization)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(io.opentracing.Tracer tracer)

Method Detail

withTraceNothing

public ServerTracingDynamicFeature.Builder withTraceNothing()

Only resources annotated with Traced will be traced.

Returns:

builder

withDecorators

public ServerTracingDynamicFeature.Builder withDecorators(List<ServerSpanDecorator> spanDecorators)

Set span decorators.

Parameters:

spanDecorators - span decorator

Returns:

builder

withSerializationDecorators

public ServerTracingDynamicFeature.Builder withSerializationDecorators(List<InterceptorSpanDecorator> spanDecorators)

Set serialization span decorators.

Returns:

builder

withPriority

public ServerTracingDynamicFeature.Builder withPriority(int priority)

Parameters:

priority - the overriding priority for the registered component. Default is Priorities.HEADER_DECORATOR

Returns:

builder

See Also:

Priorities

withSerializationPriority

public ServerTracingDynamicFeature.Builder withSerializationPriority(int serializationPriority)

Parameters:

serializationPriority - the overriding priority for the registered component. Default is Priorities.ENTITY_CODER

Returns:

builder

See Also:

Priorities

withOperationNameProvider

public ServerTracingDynamicFeature.Builder withOperationNameProvider(OperationNameProvider.Builder builder)

Parameters:

builder - the builder for operation name provider

Returns:

withTraceSerialization

public ServerTracingDynamicFeature.Builder withTraceSerialization(boolean traceSerialization)

Parameters:

traceSerialization - whether to trace serialization

Returns:

builder

withSkipPattern

public ServerTracingDynamicFeature.Builder withSkipPattern(String skipPattern)

Parameters:

skipPattern - skip pattern e.g. /health|/status

Returns:

builder

withJoinExistingActiveSpan

public ServerTracingDynamicFeature.Builder withJoinExistingActiveSpan(boolean joinExistingActiveSpan)

Parameters:

joinExistingActiveSpan - If true, any active span on the on the current thread will be used as a parent span. If false, parent span will be extracted from HTTP headers. This feature can be used when chaining spans from lower instrumentation layers e.g. servlet instrumentation. Default is false.

Returns:

builder

build

public ServerTracingDynamicFeature build()

Returns:

server tracing dynamic feature. This feature should be manually registered to Application