io.opentracing.util

Class GlobalTracer

java.lang.Object

io.opentracing.util.GlobalTracer

All Implemented Interfaces:

Tracer

public final class GlobalTracer
extends Object
implements Tracer

Global tracer that forwards all methods to another tracer that can be configured by calling register(Tracer).

The register method should only be called once during the application initialization phase.
If the register method is never called, the default NoopTracer is used.

Nested Class Summary

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

Tracer.SpanBuilder

Method Summary

Modifier and Type	Method and Description
Tracer.SpanBuilder	buildSpan(String operationName)
<C> SpanContext	extract(Format<C> format, C carrier)
static Tracer	get() Returns the constant GlobalTracer.
<C> void	inject(SpanContext spanContext, Format<C> format, C carrier)
static boolean	isRegistered() Identify whether a Tracer has previously been registered.
static void	register(Tracer tracer) Register a Tracer to back the behaviour of the global tracer.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

get

public static Tracer get()

Returns the constant GlobalTracer.

All methods are forwarded to the currently configured tracer.
Until a tracer is explicitly configured, the NoopTracer is used.

Returns:

The global tracer constant.

See Also:

register(Tracer)

register

public static void register(Tracer tracer)

Register a Tracer to back the behaviour of the global tracer.

Registration is a one-time operation, attempting to call it more often will result in a runtime exception.

Every application intending to use the global tracer is responsible for registering it once during its initialization.

Parameters:

tracer - Tracer to use as global tracer.

Throws:

RuntimeException - if there is already a current tracer registered

isRegistered

public static boolean isRegistered()

Identify whether a Tracer has previously been registered.

This check is useful in scenarios where more than one component may be responsible for registering a tracer. For example, when using a Java Agent, it will need to determine if the application has already registered a tracer, and if not attempt to resolve and register one itself.

Returns:

Whether a tracer has been registered

buildSpan

public Tracer.SpanBuilder buildSpan(String operationName)

Specified by:

buildSpan in interface Tracer

inject

public <C> void inject(SpanContext spanContext,
                       Format<C> format,
                       C carrier)

Specified by:

inject in interface Tracer

extract

public <C> SpanContext extract(Format<C> format,
                               C carrier)

Specified by:

extract in interface Tracer

toString

public String toString()

Overrides:

toString in class Object