rocks.inspectit.agent.java.sdk.opentracing.internal.impl

Class TracerImpl

java.lang.Object

rocks.inspectit.agent.java.sdk.opentracing.internal.impl.TracerImpl

All Implemented Interfaces:

io.opentracing.Tracer, ExtendedTracer

public class TracerImpl
extends java.lang.Object
implements ExtendedTracer

The io.opentracing tracer implementation. This tracer keeps the thread context state. Every time a span is started it will be added to the current thread span stack. Every time span is finished it will be removed from the thread stack.

The tracer uses Timer for time measurement. inspectIT SDK provides a simple timer implementation (SystemTimer), as it needs to be compatible with java 6.

The tracer uses Reporter for reporting finished spans. In inspectIT SDK there is an option to explicitly state that span should not be reported, as inspectIT itself adds other information to the span it creates and reports them itself. User created spans will always be reported if not explicitly stated otherwise.

Nested Class Summary

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

io.opentracing.Tracer.SpanBuilder

Constructor Summary

Constructors

Constructor and Description
TracerImpl() Initializes the tracer with SystemTimer and NoopReporter.
TracerImpl(Timer timer, Reporter reporter, boolean setToTracerProvider) Default constructor.

Method Summary

Modifier and Type	Method and Description
SpanBuilderImpl	buildSpan() Builds span with no operation name.
SpanBuilderImpl	buildSpan(java.lang.String operationName)
SpanBuilderImpl	buildSpan(java.lang.String operationName, java.lang.String referenceType, boolean useThreadContext) Creates SpanBuilder that optionally adds the reference to the current thread context span.
<C> io.opentracing.SpanContext	extract(io.opentracing.propagation.Format<C> format, C carrier)
SpanContextImpl	getCurrentContext() Returns the current thread span context if one exists.
<C> void	inject(io.opentracing.SpanContext spanContext, io.opentracing.propagation.Format<C> format, C carrier)
boolean	isCurrentContextExisting() Returns if the thread context 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 class java.lang.Object

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

Constructor Detail

TracerImpl

public TracerImpl()

Initializes the tracer with SystemTimer and NoopReporter. Please use TracerImpl(Timer, Reporter, boolean) for initialization with reporter of your choice.

TracerImpl

public TracerImpl(Timer timer,
                  Reporter reporter,
                  boolean setToTracerProvider)

Default constructor. Timer and Reporter for this tracer must be provided.

Parameters:

timer - Timer

reporter - Reporter

setToTracerProvider - If this tracer should be set to the TracerProvider class for static usage.

Method Detail

registerPropagator

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

Registers propagator.

Specified by:

registerPropagator in interface ExtendedTracer

Type Parameters:

C - format type

Parameters:

format - opentracing Format

propagator - Propagator

buildSpan

public SpanBuilderImpl buildSpan()

Builds span with no operation name.

Specified by:

buildSpan in interface ExtendedTracer

Returns:

SpanBuilder.

buildSpan

public SpanBuilderImpl buildSpan(java.lang.String operationName)

Note that as tracer is thread span context aware this method will automatically add reference (CHILD_OF) to the current thread span context if the one exists. If you want to manually specify reference type or want to ignore the current thread context then use buildSpan(String, String, boolean).

Specified by:

buildSpan in interface io.opentracing.Tracer

buildSpan

public SpanBuilderImpl buildSpan(java.lang.String operationName,
                                 java.lang.String referenceType,
                                 boolean useThreadContext)

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

Specified by:

buildSpan in interface ExtendedTracer

Parameters:

operationName - Operation name of the span.

referenceType - Reference type to the current context.

useThreadContext - If thread context should be used.

Returns:

SpanBuilder.

inject

public <C> void inject(io.opentracing.SpanContext spanContext,
                       io.opentracing.propagation.Format<C> format,
                       C carrier)

Specified by:

inject in interface io.opentracing.Tracer

extract

public <C> io.opentracing.SpanContext extract(io.opentracing.propagation.Format<C> format,
                                              C carrier)

Specified by:

extract in interface io.opentracing.Tracer

getCurrentContext

public SpanContextImpl 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.

Specified by:

getCurrentContext in interface ExtendedTracer

Returns:

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

isCurrentContextExisting

public boolean isCurrentContextExisting()

Returns if the thread context exists.

Returns:

Returns if the thread context exists.

setTimer

public void setTimer(Timer timer)

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.

Specified by:

setTimer in interface ExtendedTracer

Parameters:

timer - Timer to set. Must not be null.