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

Class EntrySpan

java.lang.Object

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

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

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

All Implemented Interfaces:

AsyncSpan, AbstractSpan

public class EntrySpan
extends StackBasedTracingSpan

The EntrySpan represents a service provider point, such as Tomcat server entrance. It is a start point of TraceSegment, even in a complex application, there maybe have multi-layer entry point, the EntrySpan only represents the first one. But with the last EntrySpan's tags and logs, which have more details about a service provider. Such as: Tomcat Embed - Dubbox The EntrySpan represents the Dubbox span.

Author:

wusheng

Field Summary

Fields inherited from class org.apache.skywalking.apm.agent.core.context.trace.StackBasedTracingSpan

peer, peerId, stackDepth

Fields inherited from class org.apache.skywalking.apm.agent.core.context.trace.AbstractTracingSpan

componentId, componentName, context, endTime, errorOccurred, isInAsyncMode, layer, logs, operationId, operationName, parentSpanId, refs, spanId, startTime, tags

Constructor Summary

Constructors

Constructor and Description
EntrySpan(int spanId, int parentSpanId, int operationId)
EntrySpan(int spanId, int parentSpanId, String operationName)

Method Summary

Modifier and Type	Method and Description
boolean	isEntry()
boolean	isExit()
EntrySpan	log(Throwable t) Record an exception event of the current walltime timestamp.
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.
EntrySpan	start() Set the AbstractTracingSpan.startTime, when the first start, which means the first service provided.
EntrySpan	tag(String key, String value) Set a key:value tag on the Span.

Methods inherited from class org.apache.skywalking.apm.agent.core.context.trace.StackBasedTracingSpan

finish, setPeer, transform

Methods inherited from class org.apache.skywalking.apm.agent.core.context.trace.AbstractTracingSpan

asyncFinish, errorOccurred, getOperationId, getOperationName, getSpanId, log, prepareForAsync, ref, start, tag

Methods inherited from class java.lang.Object

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

Constructor Detail

EntrySpan

public EntrySpan(int spanId,
                 int parentSpanId,
                 String operationName)

EntrySpan

public EntrySpan(int spanId,
                 int parentSpanId,
                 int operationId)

Method Detail

start

public EntrySpan start()

Set the AbstractTracingSpan.startTime, when the first start, which means the first service provided.

Specified by:

start in interface AbstractSpan

Overrides:

start in class AbstractTracingSpan

Returns:

this Span instance, for chaining

tag

public EntrySpan tag(String key,
                     String value)

Description copied from class: AbstractTracingSpan

Set a key:value tag on the Span.

Specified by:

tag in interface AbstractSpan

Overrides:

tag in class AbstractTracingSpan

Returns:

this Span instance, for chaining

setLayer

public AbstractTracingSpan setLayer(SpanLayer layer)

Specified by:

setLayer in interface AbstractSpan

Overrides:

setLayer in class AbstractTracingSpan

setComponent

public AbstractTracingSpan setComponent(Component component)

Description copied from class: AbstractTracingSpan

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

Specified by:

setComponent in interface AbstractSpan

Overrides:

setComponent in class AbstractTracingSpan

Returns:

span instance, for chaining.

setComponent

public AbstractTracingSpan setComponent(String componentName)

Description copied from class: AbstractTracingSpan

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

Specified by:

setComponent in interface AbstractSpan

Overrides:

setComponent in class AbstractTracingSpan

Returns:

span instance, for chaining.

setOperationName

public AbstractTracingSpan setOperationName(String operationName)

Description copied from class: AbstractTracingSpan

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

Overrides:

setOperationName in class AbstractTracingSpan

Returns:

span instance, for chaining.

setOperationId

public AbstractTracingSpan setOperationId(int operationId)

Description copied from class: AbstractTracingSpan

Set the operation id, which compress by the name.

Specified by:

setOperationId in interface AbstractSpan

Overrides:

setOperationId in class AbstractTracingSpan

Returns:

span instance, for chaining.

log

public EntrySpan log(Throwable t)

Description copied from class: AbstractTracingSpan

Record an exception event of the current walltime timestamp.

Specified by:

log in interface AbstractSpan

Overrides:

log in class AbstractTracingSpan

Parameters:

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

Returns:

the Span, for chaining

isEntry

public boolean isEntry()

Returns:

true if the actual span is an entry span.

isExit

public boolean isExit()

Returns:

true if the actual span is an exit span.