org.apache.skywalking.apm.agent.core.context

Class ContextManager

java.lang.Object

org.apache.skywalking.apm.agent.core.context.ContextManager

All Implemented Interfaces:

BootService

public class ContextManager
extends Object
implements BootService

ContextManager controls the whole context of TraceSegment. Any TraceSegment relates to single-thread, so this context use ThreadLocal to maintain the context, and make sure, since a TraceSegment starts, all ChildOf spans are in the same context.

What is 'ChildOf'? https://github.com/opentracing/specification/blob/master/specification.md#references-between-spans

Also, ContextManager delegates to all AbstractTracerContext's major methods.

Author:

wusheng

Constructor Summary

Constructors

Constructor and Description
ContextManager()

Method Summary

Modifier and Type	Method and Description
static AbstractSpan	activeSpan() If not sure has the active span, use this method, will be cause NPE when has no active span, use ContextManager::isActive method to determine whether there has the active span.
static AbstractTracerContext	awaitFinishAsync(AbstractSpan span)
void	boot()
static ContextSnapshot	capture()
static void	continued(ContextSnapshot snapshot)
static AbstractSpan	createEntrySpan(String operationName, ContextCarrier carrier)
static AbstractSpan	createExitSpan(String operationName, ContextCarrier carrier, String remotePeer)
static AbstractSpan	createExitSpan(String operationName, String remotePeer)
static AbstractSpan	createLocalSpan(String operationName)
static void	extract(ContextCarrier carrier)
static String	getGlobalTraceId()
static RuntimeContext	getRuntimeContext()
static void	inject(ContextCarrier carrier)
static boolean	isActive()
void	onComplete()
void	prepare()
void	shutdown()
static void	stopSpan() Recommend use ContextManager::stopSpan(AbstractSpan span), because in that way, the TracingContext core could verify this span is the active one, in order to avoid stop unexpected span.
static void	stopSpan(AbstractSpan span)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextManager

public ContextManager()

Method Detail

getGlobalTraceId

public static String getGlobalTraceId()

Returns:

the first global trace id if needEnhance. Otherwise, "N/A".

createEntrySpan

public static AbstractSpan createEntrySpan(String operationName,
                                           ContextCarrier carrier)

createLocalSpan

public static AbstractSpan createLocalSpan(String operationName)

createExitSpan

public static AbstractSpan createExitSpan(String operationName,
                                          ContextCarrier carrier,
                                          String remotePeer)

createExitSpan

public static AbstractSpan createExitSpan(String operationName,
                                          String remotePeer)

inject

public static void inject(ContextCarrier carrier)

extract

public static void extract(ContextCarrier carrier)

capture

public static ContextSnapshot capture()

continued

public static void continued(ContextSnapshot snapshot)

awaitFinishAsync

public static AbstractTracerContext awaitFinishAsync(AbstractSpan span)

activeSpan

public static AbstractSpan activeSpan()

If not sure has the active span, use this method, will be cause NPE when has no active span, use ContextManager::isActive method to determine whether there has the active span.

stopSpan

public static void stopSpan()

Recommend use ContextManager::stopSpan(AbstractSpan span), because in that way, the TracingContext core could verify this span is the active one, in order to avoid stop unexpected span. If the current span is hard to get or only could get by low-performance way, this stop way is still acceptable.

stopSpan

public static void stopSpan(AbstractSpan span)

prepare

public void prepare()
             throws Throwable

Specified by:

prepare in interface BootService

Throws:

Throwable

boot

public void boot()

Specified by:

boot in interface BootService

onComplete

public void onComplete()
                throws Throwable

Specified by:

onComplete in interface BootService

Throws:

Throwable

shutdown

public void shutdown()
              throws Throwable

Specified by:

shutdown in interface BootService

Throws:

Throwable

isActive

public static boolean isActive()

getRuntimeContext

public static RuntimeContext getRuntimeContext()