openconsensus.trace

Class SpanData

java.lang.Object

openconsensus.trace.SpanData

@Immutable
public abstract class SpanData
extends Object

Immutable representation of all data collected by the Span class.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpanData.TimedEvent A timed event representation.
static class	SpanData.Timestamp A representation of an instant in time.

Method Summary

Modifier and Type	Method and Description
static SpanData	create(SpanContext context, SpanId parentSpanId, Resource resource, String name, Span.Kind kind, SpanData.Timestamp startTimestamp, Map<String,AttributeValue> attributes, List<SpanData.TimedEvent> timedEvents, List<Link> links, Status status, SpanData.Timestamp endTimestamp) Returns a new immutable SpanData.
abstract Map<String,AttributeValue>	getAttributes() Returns the attributes recorded for this Span.
abstract SpanContext	getContext() Returns the SpanContext associated with this Span.
abstract SpanData.Timestamp	getEndTimestamp() Returns the end Timestamp.
abstract Span.Kind	getKind() Returns the kind of this Span.
abstract List<Link>	getLinks() Returns links recorded for this Span.
abstract String	getName() Returns the name of this Span.
abstract SpanId	getParentSpanId() Returns the parent SpanId or null if the Span is a root Span.
abstract Resource	getResource() Returns the resource of this Span.
abstract SpanData.Timestamp	getStartTimestamp() Returns the start Timestamp of this Span.
abstract Status	getStatus() Returns the Status.
abstract List<SpanData.TimedEvent>	getTimedEvents() Returns the timed events recorded for this Span.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SpanData create(SpanContext context,
                              @Nullable
                              SpanId parentSpanId,
                              Resource resource,
                              String name,
                              Span.Kind kind,
                              SpanData.Timestamp startTimestamp,
                              Map<String,AttributeValue> attributes,
                              List<SpanData.TimedEvent> timedEvents,
                              List<Link> links,
                              Status status,
                              SpanData.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.

resource - the resource this span was executed on.

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.

timedEvents - the events associated with the Span.

links - the links associated with the Span.

status - the Status of the Span.

endTimestamp - the end Timestamp of the Span.

Returns:

a new immutable SpanData.

Since:

0.1.0

getContext

public abstract SpanContext getContext()

Returns the SpanContext associated with this Span.

Returns:

the SpanContext associated with this Span.

Since:

0.1.0

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

getResource

public abstract Resource getResource()

Returns the resource of this Span.

Returns:

the resource of this Span.

Since:

0.1.0

getName

public abstract String getName()

Returns the name of this Span.

Returns:

the name of this Span.

Since:

0.1.0

getKind

public abstract Span.Kind getKind()

Returns the kind of this Span.

Returns:

the kind of this Span.

Since:

0.1.0

getStartTimestamp

public abstract SpanData.Timestamp getStartTimestamp()

Returns the start Timestamp of this Span.

Returns:

the start Timestamp of this Span.

Since:

0.1.0

getAttributes

public abstract Map<String,AttributeValue> getAttributes()

Returns the attributes recorded for this Span.

Returns:

the attributes recorded for this Span.

Since:

0.1.0

getTimedEvents

public abstract List<SpanData.TimedEvent> getTimedEvents()

Returns the timed events recorded for this Span.

Returns:

the timed events recorded for this Span.

Since:

0.1.0

getLinks

public abstract List<Link> getLinks()

Returns links recorded for this Span.

Returns:

links recorded for this Span.

Since:

0.1.0

getStatus

public abstract Status getStatus()

Returns the Status.

Returns:

the Status.

Since:

0.1.0

getEndTimestamp

public abstract SpanData.Timestamp getEndTimestamp()

Returns the end Timestamp.

Returns:

the end Timestamp.

Since:

0.1.0