rocks.inspectit.agent.java.sdk.opentracing

Interface ExtendedTracer

All Superinterfaces:

io.opentracing.Tracer

All Known Implementing Classes:

NoopExtendedTracerImpl, TracerImpl

public interface ExtendedTracer
extends io.opentracing.Tracer

This interface defines additional methods that inspectIT tracer provides for usage.

There are additional two methods for creating a SpanBuilder where user can choose if current thread context should be referenced or not.

The tracer allows registration of the Propagator for a specific format. This method allows overwriting of the tracer default propagators. Note that inspectIT tracer by default uses TextMapPropagator for the io.opentracing.propagation.Format.Builtin.TEXT_MAP and UrlEncodingPropagator for the io.opentracing.propagation.Format.Builtin.HTTP_HEADERS format.

Nested Class Summary

Nested classes/interfaces inherited from interface io.opentracing.Tracer

io.opentracing.Tracer.SpanBuilder

Method Summary

Modifier and Type	Method and Description
io.opentracing.Tracer.SpanBuilder	buildSpan() Builds span with no operation name.
io.opentracing.Tracer.SpanBuilder	buildSpan(java.lang.String operationName, java.lang.String referenceType, boolean useThreadContext) Creates SpanBuilder that optionally adds the reference to the current thread context span.
io.opentracing.SpanContext	getCurrentContext() Returns the current thread span context if one exists.
<C> void	registerPropagator(io.opentracing.propagation.Format<C> format, Propagator<C> propagator) Registers propagator.
void	setTimer(Timer timer) Sets the implementation of the Timer to use.

Methods inherited from interface io.opentracing.Tracer

buildSpan, extract, inject

Method Detail

registerPropagator

<C> void registerPropagator(io.opentracing.propagation.Format<C> format,
                            Propagator<C> propagator)

Registers propagator. This method allows overwriting of the tracer default propagators. Note that inspectIT tracer by default uses TextMapPropagator for the io.opentracing.propagation.Format.Builtin.TEXT_MAP and UrlEncodingPropagator for the io.opentracing.propagation.Format.Builtin.HTTP_HEADERS format.

Type Parameters:

C - format type

Parameters:

format - opentracing Format

propagator - Propagator

setTimer

void setTimer(Timer timer)
       throws java.lang.IllegalArgumentException

Sets the implementation of the Timer to use.

By default inspectIT tracer uses SystemTimer that has millisecond start time precision. This done so inspectIT can be compatible with Java 6. Users can provide better timers if they run on higher Java versions or have third party dependencies that could do better.

Parameters:

timer - Timer to set. Must not be null.

Throws:

java.lang.IllegalArgumentException - If timer provided is null.

buildSpan

io.opentracing.Tracer.SpanBuilder buildSpan()

Builds span with no operation name. The thread context reference will added if the one exists as the CHILD_OF reference.

Returns:

SpanBuilder.

buildSpan

io.opentracing.Tracer.SpanBuilder buildSpan(java.lang.String operationName,
                                            java.lang.String referenceType,
                                            boolean useThreadContext)

Creates SpanBuilder that optionally adds the reference to the current thread context span.

Parameters:

operationName - Operation name of the span.

referenceType - Reference type to the current context. Can be null if useThreadContext=false

useThreadContext - If thread context should be used.

Returns:

SpanBuilder.

getCurrentContext

io.opentracing.SpanContext getCurrentContext()

Returns the current thread span context if one exists. If the current thread has already started spans, this will return context of the last started span that is not finished yet. Otherwise this method returns null.

The noop tracer implementation should always return the NoopSpanContext instance here.

Returns:

Context of the last started (non-finished) span by current thread or null if thread has no such spans.