Package io.opentelemetry.sdk.trace.data

Interface SpanData

All Known Implementing Classes:
DelegatingSpanData
@Immutable public interface SpanData
Immutable representation of all data collected by the Span class.

  • Method Details

    • getName

      String getName()
      Returns the name of this Span.
      Returns:
      the name of this Span.

    • getKind

      io.opentelemetry.api.trace.SpanKind getKind()
      Returns the kind of this Span.
      Returns:
      the kind of this Span.

    • getSpanContext

      io.opentelemetry.api.trace.SpanContext getSpanContext()
      Returns the SpanContext of the Span.

    • getTraceId

      default String getTraceId()
      Gets the trace id for this span.
      Returns:
      the trace id.

    • getSpanId

      default String getSpanId()
      Gets the span id for this span.
      Returns:
      the span id.

    • getParentSpanContext

      io.opentelemetry.api.trace.SpanContext getParentSpanContext()
      Returns the parent SpanContext. If the span is a root span, the SpanContext returned will be invalid.

    • getParentSpanId

      default 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.

    • getStatus

      StatusData getStatus()
      Returns the Status.
      Returns:
      the Status.

    • 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.api.common.Attributes getAttributes()
      Returns the attributes recorded for this Span.
      Returns:
      the attributes recorded for this Span.

    • getEvents

      List<EventData> getEvents()
      Returns the timed events recorded for this Span.
      Returns:
      the timed events recorded for this Span.

    • getLinks

      List<LinkData> getLinks()
      Returns links recorded for this Span.
      Returns:
      links recorded for this Span.

    • getEndEpochNanos

      long getEndEpochNanos()
      Returns the end epoch timestamp in nanos of this Span.
      Returns:
      the end epoch timestamp in nanos of this Span.

    • hasEnded

      boolean hasEnded()
      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 EventData 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: SpanLimits.getMaxNumberOfEvents()
      Returns:
      The total number of events recorded on this span.

    • getTotalRecordedLinks

      int getTotalRecordedLinks()
      The total number of LinkData 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: 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 io.opentelemetry.sdk.common.InstrumentationLibraryInfo getInstrumentationLibraryInfo()
      Deprecated.
      Use getInstrumentationScopeInfo().
      Returns the instrumentation library specified when creating the tracer which produced this Span.
      Returns:
      an instance of InstrumentationLibraryInfo

    • getInstrumentationScopeInfo

      default io.opentelemetry.sdk.common.InstrumentationScopeInfo getInstrumentationScopeInfo()
      Returns the instrumentation scope specified when creating the tracer which produced this Span.
      Returns:
      an instance of InstrumentationScopeInfo

    • getResource

      io.opentelemetry.sdk.resources.Resource getResource()
      Returns the resource of this Span.
      Returns:
      the resource of this Span.