Package io.opentelemetry.sdk.trace.data
Interface SpanData
-
- All Known Implementing Classes:
AutoValue_SpanWrapper,DelegatingSpanData,SpanWrapper
@Immutable public interface SpanDataImmutable representation of all data collected by theSpanclass.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description AttributesgetAttributes()Returns the attributes recorded for thisSpan.longgetEndEpochNanos()Returns the end epoch timestamp in nanos of thisSpan.java.util.List<EventData>getEvents()Returns the timed events recorded for thisSpan.InstrumentationLibraryInfogetInstrumentationLibraryInfo()Deprecated.default InstrumentationScopeInfogetInstrumentationScopeInfo()Returns the instrumentation scope specified when creating the tracer which produced thisSpan.SpanKindgetKind()Returns the kind of thisSpan.java.util.List<LinkData>getLinks()Returns links recorded for thisSpan.java.lang.StringgetName()Returns the name of thisSpan.SpanContextgetParentSpanContext()Returns the parentSpanContext.default java.lang.StringgetParentSpanId()Returns the parentSpanId.ResourcegetResource()Returns the resource of thisSpan.SpanContextgetSpanContext()Returns theSpanContextof the Span.default java.lang.StringgetSpanId()Gets the span id for this span.longgetStartEpochNanos()Returns the start epoch timestamp in nanos of thisSpan.StatusDatagetStatus()Returns theStatus.intgetTotalAttributeCount()The total number of attributes that were recorded on this span.intgetTotalRecordedEvents()The total number ofEventDataevents that were recorded on this span.intgetTotalRecordedLinks()The total number ofLinkDatalinks that were recorded on this span.default java.lang.StringgetTraceId()Gets the trace id for this span.booleanhasEnded()Returns whether this Span has already been ended.
-
-
-
Method Detail
-
getName
java.lang.String getName()
Returns the name of thisSpan.- Returns:
- the name of this
Span.
-
getKind
SpanKind getKind()
Returns the kind of thisSpan.- Returns:
- the kind of this
Span.
-
getSpanContext
SpanContext getSpanContext()
Returns theSpanContextof the Span.
-
getTraceId
default java.lang.String getTraceId()
Gets the trace id for this span.- Returns:
- the trace id.
-
getSpanId
default java.lang.String getSpanId()
Gets the span id for this span.- Returns:
- the span id.
-
getParentSpanContext
SpanContext getParentSpanContext()
Returns the parentSpanContext. If the span is a root span, theSpanContextreturned will be invalid.
-
getParentSpanId
default java.lang.String getParentSpanId()
Returns the parentSpanId. If theSpanis a rootSpan, the SpanId returned will be invalid.- Returns:
- the parent
SpanIdor an invalid SpanId if this is a rootSpan.
-
getStatus
StatusData getStatus()
Returns theStatus.- Returns:
- the
Status.
-
getStartEpochNanos
long getStartEpochNanos()
Returns the start epoch timestamp in nanos of thisSpan.- Returns:
- the start epoch timestamp in nanos of this
Span.
-
getAttributes
Attributes getAttributes()
Returns the attributes recorded for thisSpan.- Returns:
- the attributes recorded for this
Span.
-
getEvents
java.util.List<EventData> getEvents()
Returns the timed events recorded for thisSpan.- Returns:
- the timed events recorded for this
Span.
-
getLinks
java.util.List<LinkData> getLinks()
Returns links recorded for thisSpan.- Returns:
- links recorded for this
Span.
-
getEndEpochNanos
long getEndEpochNanos()
Returns the end epoch timestamp in nanos of thisSpan.- Returns:
- the end epoch timestamp in nanos of this
Span.
-
hasEnded
boolean hasEnded()
Returns whether this Span has already been ended.- Returns:
trueif the span has already been ended,falseif not.
-
getTotalRecordedEvents
int getTotalRecordedEvents()
The total number ofEventDataevents 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:SpanLimits.getMaxNumberOfEvents()- Returns:
- The total number of events recorded on this span.
-
getTotalRecordedLinks
int getTotalRecordedLinks()
The total number ofLinkDatalinks 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:SpanLimits.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:SpanLimits.getMaxNumberOfAttributes()- Returns:
- The total number of attributes on this span.
-
getInstrumentationLibraryInfo
@Deprecated InstrumentationLibraryInfo getInstrumentationLibraryInfo()
Deprecated.Returns the instrumentation library specified when creating the tracer which produced thisSpan.- Returns:
- an instance of
InstrumentationLibraryInfo
-
getInstrumentationScopeInfo
default InstrumentationScopeInfo getInstrumentationScopeInfo()
Returns the instrumentation scope specified when creating the tracer which produced thisSpan.- Returns:
- an instance of
InstrumentationScopeInfo
-
getResource
Resource getResource()
Returns the resource of thisSpan.- Returns:
- the resource of this
Span.
-
-