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

Class IgnoredTracerContext

java.lang.Object

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

All Implemented Interfaces:

AbstractTracerContext

public class IgnoredTracerContext
extends Object
implements AbstractTracerContext

The IgnoredTracerContext represent a context should be ignored. So it just maintains the stack with an integer depth field. All operations through this will be ignored, and keep the memory and gc cost as low as possible.

Author:

wusheng

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IgnoredTracerContext.ListenerManager

Constructor Summary

Constructors

Constructor and Description
IgnoredTracerContext()

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

IgnoredTracerContext

public IgnoredTracerContext()

Method Detail

inject

public void inject(ContextCarrier carrier)

Description copied from interface: AbstractTracerContext

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

Specified by:

inject in interface AbstractTracerContext

Parameters:

carrier - to carry the context for crossing process.

extract

public void extract(ContextCarrier carrier)

Description copied from interface: AbstractTracerContext

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

Specified by:

extract in interface AbstractTracerContext

Parameters:

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

capture

public ContextSnapshot capture()

Description copied from interface: AbstractTracerContext

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.

Specified by:

capture in interface AbstractTracerContext

Returns:

the ContextSnapshot , which includes the reference context.

continued

public void continued(ContextSnapshot snapshot)

Description copied from interface: AbstractTracerContext

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

Specified by:

continued in interface AbstractTracerContext

Parameters:

snapshot - from AbstractTracerContext.capture() in the parent thread.

getReadableGlobalTraceId

public String getReadableGlobalTraceId()

Description copied from interface: AbstractTracerContext

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

Specified by:

getReadableGlobalTraceId in interface AbstractTracerContext

Returns:

the string represents the id.

createEntrySpan

public AbstractSpan createEntrySpan(String operationName)

Description copied from interface: AbstractTracerContext

Create an entry span

Specified by:

createEntrySpan in interface AbstractTracerContext

Parameters:

operationName - most likely a service name

Returns:

the span represents an entry point of this segment.

createLocalSpan

public AbstractSpan createLocalSpan(String operationName)

Description copied from interface: AbstractTracerContext

Create a local span

Specified by:

createLocalSpan in interface AbstractTracerContext

Parameters:

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

Returns:

the span represents a local logic block.

createExitSpan

public AbstractSpan createExitSpan(String operationName,
                                   String remotePeer)

Description copied from interface: AbstractTracerContext

Create an exit span

Specified by:

createExitSpan in interface AbstractTracerContext

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

public AbstractSpan activeSpan()

Specified by:

activeSpan in interface AbstractTracerContext

Returns:

the active span of current tracing context(stack)

stopSpan

public boolean stopSpan(AbstractSpan span)

Description copied from interface: AbstractTracerContext

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

Specified by:

stopSpan in interface AbstractTracerContext

Parameters:

span - to finish

Returns:

true when context should be clear.

awaitFinishAsync

public AbstractTracerContext awaitFinishAsync()

Description copied from interface: AbstractTracerContext

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

Specified by:

awaitFinishAsync in interface AbstractTracerContext

Returns:

The current context

asyncStop

public void asyncStop(AsyncSpan span)

Description copied from interface: AbstractTracerContext

The given span could be stopped officially.

Specified by:

asyncStop in interface AbstractTracerContext

Parameters:

span - to be stopped.