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

Interface AbstractSpan

All Superinterfaces:

AsyncSpan

All Known Implementing Classes:

AbstractTracingSpan, EntrySpan, ExitSpan, LocalSpan, NoopExitSpan, NoopSpan, StackBasedTracingSpan

public interface AbstractSpan
extends AsyncSpan

The AbstractSpan represents the span's skeleton, which contains all open methods.

Author:

wusheng

Method Summary

Modifier and Type	Method and Description
AbstractSpan	errorOccurred()
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.
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) Deprecated.

Methods inherited from interface org.apache.skywalking.apm.agent.core.context.AsyncSpan

asyncFinish, prepareForAsync

Method Detail

setComponent

AbstractSpan setComponent(Component component)

Set the component id, which defines in ComponentsDefine

Parameters:

component -

Returns:

the span for chaining.

setComponent

AbstractSpan setComponent(String componentName)

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

Parameters:

componentName -

Returns:

the span for chaining.

setLayer

AbstractSpan setLayer(SpanLayer layer)

tag

@Deprecated
AbstractSpan tag(String key,
                             String value)

Deprecated.

Set a key:value tag on the Span.

Returns:

this Span instance, for chaining

tag

AbstractSpan tag(AbstractTag tag,
                 String value)

Parameters:

tag -

value -

Returns:

log

AbstractSpan log(Throwable t)

Record an exception event of the current walltime timestamp.

Parameters:

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

Returns:

the Span, for chaining

errorOccurred

AbstractSpan errorOccurred()

isEntry

boolean isEntry()

Returns:

true if the actual span is an entry span.

isExit

boolean isExit()

Returns:

true if the actual span is an exit span.

log

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

Record an event at a specific timestamp.

Parameters:

timestamp - The explicit timestamp for the log record.

event - the events

Returns:

the Span, for chaining

setOperationName

AbstractSpan setOperationName(String operationName)

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

Returns:

this Span instance, for chaining

start

AbstractSpan start()

Start a span.

Returns:

this Span instance, for chaining

getSpanId

int getSpanId()

Get the id of span

Returns:

id value.

getOperationId

int getOperationId()

getOperationName

String getOperationName()

setOperationId

AbstractSpan setOperationId(int operationId)

ref

void ref(TraceSegmentRef ref)

Reference other trace segment.

Parameters:

ref - segment ref

start

AbstractSpan start(long startTime)

setPeer

AbstractSpan setPeer(String remotePeer)