org.zalando.riptide.opentracing

Class OpenTracingPlugin

java.lang.Object

org.zalando.riptide.opentracing.OpenTracingPlugin

All Implemented Interfaces:

Plugin

@API(status=EXPERIMENTAL)
public final class OpenTracingPlugin
extends Object
implements Plugin

Field Summary

Fields

Modifier and Type	Field and Description
static Attribute<Map<String,Object>>	LOGS Allows to pass arbitrary span logs directly from a call site.
static Attribute<String>	OPERATION_NAME Allows to pass a customized operation name directly from a call site.
static Attribute<io.opentracing.Span>	SPAN Allows to pass an explicit Span directly from a call site.
static Attribute<Map<String,String>>	TAGS Allows to pass arbitrary span tags directly from a call site.

Constructor Summary

Constructors

Constructor and Description
OpenTracingPlugin(io.opentracing.Tracer tracer)

Method Summary

Modifier and Type	Method and Description
RequestExecution	aroundDispatch(RequestExecution execution)
RequestExecution	aroundNetwork(RequestExecution execution)
OpenTracingPlugin	withActivation(Activation activation)
OpenTracingPlugin	withAdditionalSpanDecorators(SpanDecorator first, SpanDecorator... decorators) Creates a new plugin by combining the decorator(s) of this plugin with the supplied ones.
OpenTracingPlugin	withInjection(org.zalando.riptide.opentracing.Injection injection)
OpenTracingPlugin	withLifecycle(Lifecycle lifecycle)
OpenTracingPlugin	withSpanDecorators(SpanDecorator decorator, SpanDecorator... decorators) Creates a new plugin by replacing the decorator(s) of this plugin with the supplied ones.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zalando.riptide.Plugin

aroundAsync, aroundSerialization, composite, composite

Field Detail

SPAN

public static final Attribute<io.opentracing.Span> SPAN

Allows to pass an explicit Span directly from a call site.

OPERATION_NAME

public static final Attribute<String> OPERATION_NAME

Allows to pass a customized operation name directly from a call site. Defaults to the HTTP method.

See Also:

AttributeStage.attribute(Attribute, Object)

TAGS

public static final Attribute<Map<String,String>> TAGS

Allows to pass arbitrary span tags directly from a call site.

See Also:

AttributeStage.attribute(Attribute, Object)

LOGS

public static final Attribute<Map<String,Object>> LOGS

Allows to pass arbitrary span logs directly from a call site.

See Also:

AttributeStage.attribute(Attribute, Object)

Constructor Detail

OpenTracingPlugin

public OpenTracingPlugin(io.opentracing.Tracer tracer)

Method Detail

withLifecycle

@CheckReturnValue
public OpenTracingPlugin withLifecycle(Lifecycle lifecycle)

withActivation

@CheckReturnValue
public OpenTracingPlugin withActivation(Activation activation)

withInjection

@CheckReturnValue
public OpenTracingPlugin withInjection(org.zalando.riptide.opentracing.Injection injection)

withAdditionalSpanDecorators

@CheckReturnValue
public OpenTracingPlugin withAdditionalSpanDecorators(SpanDecorator first,
                                                                        SpanDecorator... decorators)

Creates a new plugin by combining the decorator(s) of this plugin with the supplied ones.

Parameters:

first - first decorator

decorators - optional, remaining decorators

Returns:

a new OpenTracingPlugin

withSpanDecorators

@CheckReturnValue
public OpenTracingPlugin withSpanDecorators(SpanDecorator decorator,
                                                              SpanDecorator... decorators)

Creates a new plugin by replacing the decorator(s) of this plugin with the supplied ones.

Parameters:

decorator - first decorator

decorators - optional, remaining decorators

Returns:

a new OpenTracingPlugin

aroundDispatch

public RequestExecution aroundDispatch(RequestExecution execution)

Specified by:

aroundDispatch in interface Plugin

aroundNetwork

public RequestExecution aroundNetwork(RequestExecution execution)

Specified by:

aroundNetwork in interface Plugin