io.opencensus.trace.export

Class SpanData

java.lang.Object

io.opencensus.trace.export.SpanData

@Immutable
public abstract class SpanData
extends Object

Immutable representation of all data collected by the Span class.

Since:

0.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpanData.Attributes A set of attributes and the number of dropped attributes representation.
static class	SpanData.Links A list of links and the number of dropped links representation.
static class	SpanData.TimedEvent<T> A timed event representation.
static class	SpanData.TimedEvents<T> A list of timed events and the number of dropped events representation.

Method Summary

Modifier and Type	Method and Description
static SpanData	create(SpanContext context, SpanId parentSpanId, Boolean hasRemoteParent, String name, Span.Kind kind, Timestamp startTimestamp, SpanData.Attributes attributes, SpanData.TimedEvents<Annotation> annotations, SpanData.TimedEvents<? extends BaseMessageEvent> messageOrNetworkEvents, SpanData.Links links, Integer childSpanCount, Status status, Timestamp endTimestamp) Returns a new immutable SpanData.
static SpanData	create(SpanContext context, SpanId parentSpanId, Boolean hasRemoteParent, String name, Timestamp startTimestamp, SpanData.Attributes attributes, SpanData.TimedEvents<Annotation> annotations, SpanData.TimedEvents<? extends BaseMessageEvent> messageOrNetworkEvents, SpanData.Links links, Integer childSpanCount, Status status, Timestamp endTimestamp) Deprecated. Use #create(SpanContext, SpanId, Boolean, String, Kind, Timestamp, Attributes, TimedEvents, TimedEvents, Links, Integer, Status, Timestamp).
abstract SpanData.TimedEvents<Annotation>	getAnnotations() Returns the annotations recorded for this Span.
abstract SpanData.Attributes	getAttributes() Returns the attributes recorded for this Span.
abstract Integer	getChildSpanCount() Returns the number of child spans that were generated while the Span was running.
abstract SpanContext	getContext() Returns the SpanContext associated with this Span.
abstract Timestamp	getEndTimestamp() Returns the end Timestamp or null if the Span is still active.
abstract Boolean	getHasRemoteParent() Returns true if the parent is on a different process.
abstract Span.Kind	getKind() Returns the kind of this Span.
abstract SpanData.Links	getLinks() Returns links recorded for this Span.
abstract SpanData.TimedEvents<MessageEvent>	getMessageEvents() Returns message events recorded for this Span.
abstract String	getName() Returns the name of this Span.
SpanData.TimedEvents<NetworkEvent>	getNetworkEvents() Deprecated. Use getMessageEvents().
abstract SpanId	getParentSpanId() Returns the parent SpanId or null if the Span is a root Span.
abstract Timestamp	getStartTimestamp() Returns the start Timestamp of this Span.
abstract Status	getStatus() Returns the Status or null if Span is still active.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Deprecated
public static SpanData create(SpanContext context,
                                          @Nullable
                                          SpanId parentSpanId,
                                          @Nullable
                                          Boolean hasRemoteParent,
                                          String name,
                                          Timestamp startTimestamp,
                                          SpanData.Attributes attributes,
                                          SpanData.TimedEvents<Annotation> annotations,
                                          SpanData.TimedEvents<? extends BaseMessageEvent> messageOrNetworkEvents,
                                          SpanData.Links links,
                                          @Nullable
                                          Integer childSpanCount,
                                          @Nullable
                                          Status status,
                                          @Nullable
                                          Timestamp endTimestamp)

Deprecated. Use #create(SpanContext, SpanId, Boolean, String, Kind, Timestamp, Attributes, TimedEvents, TimedEvents, Links, Integer, Status, Timestamp).

Returns a new immutable SpanData.

create

public static SpanData create(SpanContext context,
                              @Nullable
                              SpanId parentSpanId,
                              @Nullable
                              Boolean hasRemoteParent,
                              String name,
                              @Nullable
                              Span.Kind kind,
                              Timestamp startTimestamp,
                              SpanData.Attributes attributes,
                              SpanData.TimedEvents<Annotation> annotations,
                              SpanData.TimedEvents<? extends BaseMessageEvent> messageOrNetworkEvents,
                              SpanData.Links links,
                              @Nullable
                              Integer childSpanCount,
                              @Nullable
                              Status status,
                              @Nullable
                              Timestamp endTimestamp)

Returns a new immutable SpanData.

Parameters:

context - the SpanContext of the Span.

parentSpanId - the parent SpanId of the Span. null if the Span is a root.

hasRemoteParent - true if the parent Span is remote. null if this is a root span.

name - the name of the Span.

kind - the kind of the Span.

startTimestamp - the start Timestamp of the Span.

attributes - the attributes associated with the Span.

annotations - the annotations associated with the Span.

messageOrNetworkEvents - the message events (or network events for backward compatibility) associated with the Span.

links - the links associated with the Span.

childSpanCount - the number of child spans that were generated while the span was active.

status - the Status of the Span. null if the Span is still active.

endTimestamp - the end Timestamp of the Span. null if the Span is still active.

Returns:

a new immutable SpanData.

Since:

0.14

getContext

public abstract SpanContext getContext()

Returns the SpanContext associated with this Span.

Returns:

the SpanContext associated with this Span.

Since:

0.5

getParentSpanId

@Nullable
public abstract SpanId getParentSpanId()

Returns the parent SpanId or null if the Span is a root Span.

Returns:

the parent SpanId or null if the Span is a root Span.

Since:

0.5

getHasRemoteParent

@Nullable
public abstract Boolean getHasRemoteParent()

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

Returns:

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

Since:

0.5

getName

public abstract String getName()

Returns the name of this Span.

Returns:

the name of this Span.

Since:

0.5

getKind

@Nullable
public abstract Span.Kind getKind()

Returns the kind of this Span.

Returns:

the kind of this Span.

Since:

0.14

getStartTimestamp

public abstract Timestamp getStartTimestamp()

Returns the start Timestamp of this Span.

Returns:

the start Timestamp of this Span.

Since:

0.5

getAttributes

public abstract SpanData.Attributes getAttributes()

Returns the attributes recorded for this Span.

Returns:

the attributes recorded for this Span.

Since:

0.5

getAnnotations

public abstract SpanData.TimedEvents<Annotation> getAnnotations()

Returns the annotations recorded for this Span.

Returns:

the annotations recorded for this Span.

Since:

0.5

getNetworkEvents

@Deprecated
public SpanData.TimedEvents<NetworkEvent> getNetworkEvents()

Deprecated. Use getMessageEvents().

Returns network events recorded for this Span.

Returns:

network events recorded for this Span.

Since:

0.5

getMessageEvents

public abstract SpanData.TimedEvents<MessageEvent> getMessageEvents()

Returns message events recorded for this Span.

Returns:

message events recorded for this Span.

Since:

0.12

getLinks

public abstract SpanData.Links getLinks()

Returns links recorded for this Span.

Returns:

links recorded for this Span.

Since:

0.5

getChildSpanCount

@Nullable
public abstract Integer getChildSpanCount()

Returns the number of child spans that were generated while the Span was running. If not null allows service implementations to detect missing child spans.

This information is not always available.

Returns:

the number of child spans that were generated while the Span was running.

Since:

0.5

getStatus

@Nullable
public abstract Status getStatus()

Returns the Status or null if Span is still active.

Returns:

the Status or null if Span is still active.

Since:

0.5

getEndTimestamp

@Nullable
public abstract Timestamp getEndTimestamp()

Returns the end Timestamp or null if the Span is still active.

Returns:

the end Timestamp or null if the Span is still active.

Since:

0.5