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

Class NoopSpan

java.lang.Object

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

All Implemented Interfaces:

AsyncSpan, AbstractSpan

Direct Known Subclasses:

NoopExitSpan

public class NoopSpan
extends Object
implements AbstractSpan

The NoopSpan represents a span implementation without any actual operation. This span implementation is for IgnoredTracerContext, for keeping the memory and gc cost as low as possible.

Author:

wusheng

Constructor Summary

Constructors

Constructor and Description
NoopSpan()

Method Summary

Modifier and Type	Method and Description
AbstractSpan	asyncFinish() Notify the span, it could be finished.
AbstractSpan	errorOccurred()
void	finish()
int	getOperationId()
String	getOperationName()
int	getSpanId() Get the id of span
boolean	isEntry()
boolean	isExit()
AbstractSpan	log(long timestamp, Map<String,?> event) Record an event at a specific timestamp.
AbstractSpan	log(Throwable t) Record an exception event of the current walltime timestamp.
AbstractSpan	prepareForAsync() The span finish at current tracing context, but the current span is still alive, until AsyncSpan.asyncFinish() called.
void	ref(TraceSegmentRef ref) Reference other trace segment.
AbstractSpan	setComponent(Component component) Set the component id, which defines in ComponentsDefine
AbstractSpan	setComponent(String componentName) Only use this method in explicit instrumentation, like opentracing-skywalking-bridge.
AbstractSpan	setLayer(SpanLayer layer)
AbstractSpan	setOperationId(int operationId)
AbstractSpan	setOperationName(String operationName) Sets the string name for the logical operation this span represents.
AbstractSpan	setPeer(String remotePeer)
AbstractSpan	start() Start a span.
AbstractSpan	start(long startTime)
AbstractSpan	tag(AbstractTag tag, String value)
AbstractSpan	tag(String key, String value) Set a key:value tag on the Span.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoopSpan

public NoopSpan()

Method Detail

log

public AbstractSpan log(Throwable t)

Description copied from interface: AbstractSpan

Record an exception event of the current walltime timestamp.

Specified by:

log in interface AbstractSpan

Parameters:

t - any subclass of Throwable, which occurs in this span.

Returns:

the Span, for chaining

errorOccurred

public AbstractSpan errorOccurred()

Specified by:

errorOccurred in interface AbstractSpan

finish

public void finish()

setComponent

public AbstractSpan setComponent(Component component)

Description copied from interface: AbstractSpan

Set the component id, which defines in ComponentsDefine

Specified by:

setComponent in interface AbstractSpan

Returns:

the span for chaining.

setComponent

public AbstractSpan setComponent(String componentName)

Description copied from interface: AbstractSpan

Only use this method in explicit instrumentation, like opentracing-skywalking-bridge. It is highly recommended not to use this method for performance reasons.

Specified by:

setComponent in interface AbstractSpan

Returns:

the span for chaining.

setLayer

public AbstractSpan setLayer(SpanLayer layer)

Specified by:

setLayer in interface AbstractSpan

tag

public AbstractSpan tag(String key,
                        String value)

Description copied from interface: AbstractSpan

Set a key:value tag on the Span.

Specified by:

tag in interface AbstractSpan

Returns:

this Span instance, for chaining

tag

public AbstractSpan tag(AbstractTag tag,
                        String value)

Specified by:

tag in interface AbstractSpan

Returns:

isEntry

public boolean isEntry()

Specified by:

isEntry in interface AbstractSpan

Returns:

true if the actual span is an entry span.

isExit

public boolean isExit()

Specified by:

isExit in interface AbstractSpan

Returns:

true if the actual span is an exit span.

log

public AbstractSpan log(long timestamp,
                        Map<String,?> event)

Description copied from interface: AbstractSpan

Record an event at a specific timestamp.

Specified by:

log in interface AbstractSpan

Parameters:

timestamp - The explicit timestamp for the log record.

event - the events

Returns:

the Span, for chaining

setOperationName

public AbstractSpan setOperationName(String operationName)

Description copied from interface: AbstractSpan

Sets the string name for the logical operation this span represents.

Specified by:

setOperationName in interface AbstractSpan

Returns:

this Span instance, for chaining

start

public AbstractSpan start()

Description copied from interface: AbstractSpan

Start a span.

Specified by:

start in interface AbstractSpan

Returns:

this Span instance, for chaining

getSpanId

public int getSpanId()

Description copied from interface: AbstractSpan

Get the id of span

Specified by:

getSpanId in interface AbstractSpan

Returns:

id value.

getOperationId

public int getOperationId()

Specified by:

getOperationId in interface AbstractSpan

getOperationName

public String getOperationName()

Specified by:

getOperationName in interface AbstractSpan

setOperationId

public AbstractSpan setOperationId(int operationId)

Specified by:

setOperationId in interface AbstractSpan

ref

public void ref(TraceSegmentRef ref)

Description copied from interface: AbstractSpan

Reference other trace segment.

Specified by:

ref in interface AbstractSpan

Parameters:

ref - segment ref

start

public AbstractSpan start(long startTime)

Specified by:

start in interface AbstractSpan

setPeer

public AbstractSpan setPeer(String remotePeer)

Specified by:

setPeer in interface AbstractSpan

prepareForAsync

public AbstractSpan prepareForAsync()

Description copied from interface: AsyncSpan

The span finish at current tracing context, but the current span is still alive, until AsyncSpan.asyncFinish() called. This method must be called 1. In original thread(tracing context). 2. Current span is active span. During alive, tags, logs and attributes of the span could be changed, in any thread. The execution times of AsyncSpan.prepareForAsync() and AsyncSpan.asyncFinish() must match.

Specified by:

prepareForAsync in interface AsyncSpan

Returns:

the current span

asyncFinish

public AbstractSpan asyncFinish()

Description copied from interface: AsyncSpan

Notify the span, it could be finished. The execution times of AsyncSpan.prepareForAsync() and AsyncSpan.asyncFinish() must match.

Specified by:

asyncFinish in interface AsyncSpan

Returns:

the current span