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

Interface AbstractTracerContext

All Known Implementing Classes:

IgnoredTracerContext, TracingContext

public interface AbstractTracerContext

The AbstractTracerContext represents the tracer context manager.

Author:

wusheng

Method Summary

Modifier and Type	Method and Description
AbstractSpan	activeSpan()
void	asyncStop(AsyncSpan span) The given span could be stopped officially.
AbstractTracerContext	awaitFinishAsync() Notify this context, current span is going to be finished async in another thread.
ContextSnapshot	capture() Capture a snapshot for cross-thread propagation.
void	continued(ContextSnapshot snapshot) Build the reference between this segment and a cross-thread segment.
AbstractSpan	createEntrySpan(String operationName) Create an entry span
AbstractSpan	createExitSpan(String operationName, String remotePeer) Create an exit span
AbstractSpan	createLocalSpan(String operationName) Create a local span
void	extract(ContextCarrier carrier) Build the reference between this segment and a cross-process segment.
String	getReadableGlobalTraceId() Get the global trace id, if needEnhance.
void	inject(ContextCarrier carrier) Prepare for the cross-process propagation.
boolean	stopSpan(AbstractSpan span) Finish the given span, and the given span should be the active span of current tracing context(stack)

Method Detail

inject

void inject(ContextCarrier carrier)

Prepare for the cross-process propagation. How to initialize the carrier, depends on the implementation.

Parameters:

carrier - to carry the context for crossing process.

extract

void extract(ContextCarrier carrier)

Build the reference between this segment and a cross-process segment. How to build, depends on the implementation.

Parameters:

carrier - carried the context from a cross-process segment.

capture

ContextSnapshot capture()

Capture a snapshot for cross-thread propagation. It's a similar concept with ActiveSpan.Continuation in OpenTracing-java How to build, depends on the implementation.

Returns:

the ContextSnapshot , which includes the reference context.

continued

void continued(ContextSnapshot snapshot)

Build the reference between this segment and a cross-thread segment. How to build, depends on the implementation.

Parameters:

snapshot - from capture() in the parent thread.

getReadableGlobalTraceId

String getReadableGlobalTraceId()

Get the global trace id, if needEnhance. How to build, depends on the implementation.

Returns:

the string represents the id.

createEntrySpan

AbstractSpan createEntrySpan(String operationName)

Create an entry span

Parameters:

operationName - most likely a service name

Returns:

the span represents an entry point of this segment.

createLocalSpan

AbstractSpan createLocalSpan(String operationName)

Create a local span

Parameters:

operationName - most likely a local method signature, or business name.

Returns:

the span represents a local logic block.

createExitSpan

AbstractSpan createExitSpan(String operationName,
                            String remotePeer)

Create an exit span

Parameters:

operationName - most likely a service name of remote

remotePeer - the network id(ip:port, hostname:port or ip1:port1,ip2,port, etc.)

Returns:

the span represent an exit point of this segment.

activeSpan

AbstractSpan activeSpan()

Returns:

the active span of current tracing context(stack)

stopSpan

boolean stopSpan(AbstractSpan span)

Finish the given span, and the given span should be the active span of current tracing context(stack)

Parameters:

span - to finish

Returns:

true when context should be clear.

awaitFinishAsync

AbstractTracerContext awaitFinishAsync()

Notify this context, current span is going to be finished async in another thread.

Returns:

The current context

asyncStop

void asyncStop(AsyncSpan span)

The given span could be stopped officially.

Parameters:

span - to be stopped.