io.opentelemetry.sdk.trace.data

Interface SpanData

@Immutable
public interface SpanData

Immutable representation of all data collected by the Span class.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SpanData.Event
static interface	SpanData.Link A link to a Span.
static interface	SpanData.Status Defines the status of a Span by providing a standard StatusCanonicalCode in conjunction with an optional descriptive message.

Method Summary

Modifier and Type	Method and Description
io.opentelemetry.common.ReadableAttributes	getAttributes() Returns the attributes recorded for this Span.
long	getEndEpochNanos() Returns the end epoch timestamp in nanos of this Span.
List<SpanData.Event>	getEvents() Returns the timed events recorded for this Span.
boolean	getHasEnded() Returns whether this Span has already been ended.
boolean	getHasRemoteParent() Returns true if the parent is on a different process.
io.opentelemetry.sdk.common.InstrumentationLibraryInfo	getInstrumentationLibraryInfo() Returns the instrumentation library specified when creating the tracer which produced this Span.
io.opentelemetry.trace.Span.Kind	getKind() Returns the kind of this Span.
List<SpanData.Link>	getLinks() Returns links recorded for this Span.
String	getName() Returns the name of this Span.
String	getParentSpanId() Returns the parent SpanId.
io.opentelemetry.sdk.resources.Resource	getResource() Returns the resource of this Span.
String	getSpanId() Gets the span id for this span.
long	getStartEpochNanos() Returns the start epoch timestamp in nanos of this Span.
SpanData.Status	getStatus() Returns the Status.
int	getTotalAttributeCount() The total number of attributes that were recorded on this span.
int	getTotalRecordedEvents() The total number of SpanData.Event events that were recorded on this span.
int	getTotalRecordedLinks() The total number of ImmutableLink links that were recorded on this span.
String	getTraceId() Gets the trace id for this span.
io.opentelemetry.trace.TraceState	getTraceState() Gets the TraceState for this span.
boolean	isSampled() Whether the 'sampled' option set on this span.

Method Detail

getTraceId

String getTraceId()

Gets the trace id for this span.

Returns:

the trace id.

getSpanId

String getSpanId()

Gets the span id for this span.

Returns:

the span id.

isSampled

boolean isSampled()

Whether the 'sampled' option set on this span.

getTraceState

io.opentelemetry.trace.TraceState getTraceState()

Gets the TraceState for this span.

Returns:

the TraceState for this span.

getParentSpanId

String getParentSpanId()

Returns the parent SpanId. If the Span is a root Span, the SpanId returned will be invalid..

Returns:

the parent SpanId or an invalid SpanId if this is a root Span.

getResource

io.opentelemetry.sdk.resources.Resource getResource()

Returns the resource of this Span.

Returns:

the resource of this Span.

getInstrumentationLibraryInfo

io.opentelemetry.sdk.common.InstrumentationLibraryInfo getInstrumentationLibraryInfo()

Returns the instrumentation library specified when creating the tracer which produced this Span.

Returns:

an instance of InstrumentationLibraryInfo

getName

String getName()

Returns the name of this Span.

Returns:

the name of this Span.

getKind

io.opentelemetry.trace.Span.Kind getKind()

Returns the kind of this Span.

Returns:

the kind of this Span.

getStartEpochNanos

long getStartEpochNanos()

Returns the start epoch timestamp in nanos of this Span.

Returns:

the start epoch timestamp in nanos of this Span.

getAttributes

io.opentelemetry.common.ReadableAttributes getAttributes()

Returns the attributes recorded for this Span.

Returns:

the attributes recorded for this Span.

getEvents

List<SpanData.Event> getEvents()

Returns the timed events recorded for this Span.

Returns:

the timed events recorded for this Span.

getLinks

List<SpanData.Link> getLinks()

Returns links recorded for this Span.

Returns:

links recorded for this Span.

getStatus

SpanData.Status getStatus()

Returns the Status.

Returns:

the Status.

getEndEpochNanos

long getEndEpochNanos()

Returns the end epoch timestamp in nanos of this Span.

Returns:

the end epoch timestamp in nanos of this Span.

getHasRemoteParent

boolean getHasRemoteParent()

Returns true if the parent is on a different process. false if this is a root span.

Returns:

true if the parent is on a different process. false if this is a root span.

getHasEnded

boolean getHasEnded()

Returns whether this Span has already been ended.

Returns:

true if the span has already been ended, false if not.

getTotalRecordedEvents

int getTotalRecordedEvents()

The total number of SpanData.Event events that were recorded on this span. This number may be larger than the number of events that are attached to this span, if the total number recorded was greater than the configured maximum value. See: TraceConfig.getMaxNumberOfEvents()

Returns:

The total number of events recorded on this span.

getTotalRecordedLinks

int getTotalRecordedLinks()

The total number of ImmutableLink links that were recorded on this span. This number may be larger than the number of links that are attached to this span, if the total number recorded was greater than the configured maximum value. See: TraceConfig.getMaxNumberOfLinks()

Returns:

The total number of links recorded on this span.

getTotalAttributeCount

int getTotalAttributeCount()

The total number of attributes that were recorded on this span. This number may be larger than the number of attributes that are attached to this span, if the total number recorded was greater than the configured maximum value. See: TraceConfig.getMaxNumberOfAttributes()

Returns:

The total number of attributes on this span.