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

Class AbstractTracingSpan

java.lang.Object

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

All Implemented Interfaces:

AsyncSpan, AbstractSpan

Direct Known Subclasses:

LocalSpan, StackBasedTracingSpan

public abstract class AbstractTracingSpan
extends Object
implements AbstractSpan

The AbstractTracingSpan represents a group of AbstractSpan implementations, which belongs a real distributed trace.

Author:

wusheng

Field Summary

Fields

Modifier and Type	Field and Description
protected int	componentId
protected String	componentName
protected AbstractTracerContext	context
protected long	endTime The end time of this Span.
protected boolean	errorOccurred Error has occurred in the scope of span.
protected boolean	isInAsyncMode The span has been tagged in async mode, required async stop to finish.
protected SpanLayer	layer
protected List<LogDataEntity>	logs Log is a concept from OpenTracing spec.
protected int	operationId
protected String	operationName
protected int	parentSpanId
protected List<TraceSegmentRef>	refs The refs of parent trace segments, except the primary one.
protected int	spanId
protected long	startTime The start time of this Span.
protected List<TagValuePair>	tags

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTracingSpan(int spanId, int parentSpanId, int operationId)
protected	AbstractTracingSpan(int spanId, int parentSpanId, String operationName)

Method Summary

Modifier and Type	Method and Description
AbstractSpan	asyncFinish() Notify the span, it could be finished.
AbstractTracingSpan	errorOccurred() In the scope of this span tracing context, error occurred, in auto-instrumentation mechanism, almost means throw an exception.
boolean	finish(TraceSegment owner) Finish the active Span.
int	getOperationId()
String	getOperationName()
int	getSpanId() Get the id of span
AbstractTracingSpan	log(long timestampMicroseconds, Map<String,?> fields) Record a common log with multi fields, for supporting opentracing-java
AbstractTracingSpan	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.
AbstractTracingSpan	setComponent(Component component) Set the component of this span, with internal supported.
AbstractTracingSpan	setComponent(String componentName) Set the component name.
AbstractTracingSpan	setLayer(SpanLayer layer)
AbstractTracingSpan	setOperationId(int operationId) Set the operation id, which compress by the name.
AbstractTracingSpan	setOperationName(String operationName) Set the operation name, just because these is not compress dictionary value for this name.
AbstractTracingSpan	start() Start a span.
AbstractSpan	start(long startTime)
AbstractTracingSpan	tag(AbstractTag tag, String value)
AbstractTracingSpan	tag(String key, String value) Deprecated.
SpanObjectV2.Builder	transform()

Methods inherited from class java.lang.Object

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

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

isEntry, isExit, setPeer

Field Detail

spanId

protected int spanId

parentSpanId

protected int parentSpanId

tags

protected List<TagValuePair> tags

operationName

protected String operationName

operationId

protected int operationId

layer

protected SpanLayer layer

isInAsyncMode

protected volatile boolean isInAsyncMode

The span has been tagged in async mode, required async stop to finish.

context

protected volatile AbstractTracerContext context

startTime

protected long startTime

The start time of this Span.

endTime

protected long endTime

The end time of this Span.

errorOccurred

protected boolean errorOccurred

Error has occurred in the scope of span.

componentId

protected int componentId

componentName

protected String componentName

logs

protected List<LogDataEntity> logs

Log is a concept from OpenTracing spec. https://github.com/opentracing/specification/blob/master/specification.md#log-structured-data

refs

protected List<TraceSegmentRef> refs

The refs of parent trace segments, except the primary one. For most RPC call, refs contains only one element, but if this segment is a start span of batch process, the segment faces multi parents, at this moment, we use this refs to link them.

Constructor Detail

AbstractTracingSpan

protected AbstractTracingSpan(int spanId,
                              int parentSpanId,
                              String operationName)

AbstractTracingSpan

protected AbstractTracingSpan(int spanId,
                              int parentSpanId,
                              int operationId)

Method Detail

tag

@Deprecated
public AbstractTracingSpan tag(String key,
                                           String value)

Deprecated.

Set a key:value tag on the Span.

Specified by:

tag in interface AbstractSpan

Returns:

this Span instance, for chaining

tag

public AbstractTracingSpan tag(AbstractTag tag,
                               String value)

Specified by:

tag in interface AbstractSpan

Returns:

finish

public boolean finish(TraceSegment owner)

Finish the active Span. When it is finished, it will be archived by the given TraceSegment, which owners it.

Parameters:

owner - of the Span.

start

public AbstractTracingSpan start()

Description copied from interface: AbstractSpan

Start a span.

Specified by:

start in interface AbstractSpan

Returns:

this Span instance, for chaining

log

public AbstractTracingSpan log(Throwable t)

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

log

public AbstractTracingSpan log(long timestampMicroseconds,
                               Map<String,?> fields)

Record a common log with multi fields, for supporting opentracing-java

Specified by:

log in interface AbstractSpan

Parameters:

fields -

timestampMicroseconds - The explicit timestamp for the log record.

Returns:

the Span, for chaining

errorOccurred

public AbstractTracingSpan errorOccurred()

In the scope of this span tracing context, error occurred, in auto-instrumentation mechanism, almost means throw an exception.

Specified by:

errorOccurred in interface AbstractSpan

Returns:

span instance, for chaining.

setOperationName

public AbstractTracingSpan setOperationName(String operationName)

Set the operation name, just because these is not compress dictionary value for this name. Use the entire string temporarily, the agent will compress this name in async mode.

Specified by:

setOperationName in interface AbstractSpan

Parameters:

operationName -

Returns:

span instance, for chaining.

setOperationId

public AbstractTracingSpan setOperationId(int operationId)

Set the operation id, which compress by the name.

Specified by:

setOperationId in interface AbstractSpan

Parameters:

operationId -

Returns:

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

setLayer

public AbstractTracingSpan setLayer(SpanLayer layer)

Specified by:

setLayer in interface AbstractSpan

setComponent

public AbstractTracingSpan setComponent(Component component)

Set the component of this span, with internal supported. Highly recommend to use this way.

Specified by:

setComponent in interface AbstractSpan

Parameters:

component -

Returns:

span instance, for chaining.

setComponent

public AbstractTracingSpan setComponent(String componentName)

Set the component name. By using this, cost more memory and network.

Specified by:

setComponent in interface AbstractSpan

Parameters:

componentName -

Returns:

span instance, for chaining.

start

public AbstractSpan start(long startTime)

Specified by:

start in interface AbstractSpan

transform

public SpanObjectV2.Builder transform()

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

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