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

Class NoopExtendedTracerImpl

java.lang.Object

rocks.inspectit.agent.java.sdk.opentracing.internal.noop.NoopExtendedTracerImpl

All Implemented Interfaces:

io.opentracing.NoopTracer, io.opentracing.Tracer, ExtendedTracer

public final class NoopExtendedTracerImpl
extends java.lang.Object
implements ExtendedTracer, io.opentracing.NoopTracer

No-operation tracer that implement the ExtendedTracer interface. Simply delegates calls to the NoopTracer of the opentracing.io.

Nested Class Summary

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

io.opentracing.Tracer.SpanBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static NoopExtendedTracerImpl	INSTANCE Instance for usage.

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)
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.
<C> io.opentracing.SpanContext	extract(io.opentracing.propagation.Format<C> format, C carrier)
io.opentracing.SpanContext	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)
<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

Field Detail

INSTANCE

public static final NoopExtendedTracerImpl INSTANCE

Instance for usage.

Method Detail

buildSpan

public io.opentracing.Tracer.SpanBuilder buildSpan(java.lang.String operationName)

Specified by:

buildSpan in interface io.opentracing.Tracer

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

registerPropagator

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

Specified by:

registerPropagator in interface ExtendedTracer

Type Parameters:

C - format type

Parameters:

format - opentracing Format

propagator - Propagator

setTimer

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

Specified by:

setTimer in interface ExtendedTracer

Parameters:

timer - Timer to set. Must not be null.

Throws:

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

buildSpan

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

Specified by:

buildSpan in interface ExtendedTracer

Returns:

SpanBuilder.

buildSpan

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

Specified by:

buildSpan in interface ExtendedTracer

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

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

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.