Class RecordEventsSpanImpl

java.lang.Object

io.opencensus.trace.Span

io.opencensus.implcore.trace.RecordEventsSpanImpl

All Implemented Interfaces:

ConcurrentIntrusiveList.Element<RecordEventsSpanImpl>

@ThreadSafe
public final class RecordEventsSpanImpl
extends Span
implements ConcurrentIntrusiveList.Element<RecordEventsSpanImpl>

Implementation for the Span class that records trace events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	RecordEventsSpanImpl.AttributesWithCapacity
private static final class	RecordEventsSpanImpl.EventWithNanoTime<T>
static interface	RecordEventsSpanImpl.StartEndHandler	Interface to handle the start and end operations for a Span only when the Span has Span.Options.RECORD_EVENTS option.
private static final class	RecordEventsSpanImpl.TraceEvents<T>

Nested classes/interfaces inherited from class Span

Span.Kind, Span.Options

Field Summary

Fields

Modifier and Type	Field	Description
private RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<Annotation>>	annotations
private RecordEventsSpanImpl.AttributesWithCapacity	attributes
private final Clock	clock
private long	endNanoTime
private boolean	hasBeenEnded
private final Boolean	hasRemoteParent
private final Span.Kind	kind
private RecordEventsSpanImpl.TraceEvents<Link>	links
private static final Logger	logger
private RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<MessageEvent>>	messageEvents
private final String	name
private RecordEventsSpanImpl	next
private int	numberOfChildren
private final SpanId	parentSpanId
private RecordEventsSpanImpl	prev
private static final EnumSet<Span.Options>	RECORD_EVENTS_SPAN_OPTIONS
private boolean	sampleToLocalSpanStore
private final RecordEventsSpanImpl.StartEndHandler	startEndHandler
private final long	startNanoTime
private Status	status
private final TimestampConverter	timestampConverter
private final TraceParams	traceParams

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RecordEventsSpanImpl(SpanContext context, String name, Span.Kind kind, SpanId parentSpanId, Boolean hasRemoteParent, TraceParams traceParams, RecordEventsSpanImpl.StartEndHandler startEndHandler, TimestampConverter timestampConverter, Clock clock)

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(Annotation annotation)	Adds an annotation to the Span.
void	addAnnotation(String description, Map<String, AttributeValue> attributes)	Adds an annotation to the Span.
(package private) void	addChild()
void	addLink(Link link)	Adds a Link to the Span.
void	addMessageEvent(MessageEvent messageEvent)	Adds a MessageEvent to the Span.
private static <T> SpanData.TimedEvents<T>	createTimedEvents(RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<T>> events, TimestampConverter timestampConverter)
void	end(EndSpanOptions options)	Marks the end of Span execution with the given options.
long	getEndNanoTime()	Returns the end nano time (see System.nanoTime()).
private RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<Annotation>>	getInitializedAnnotations()
private RecordEventsSpanImpl.AttributesWithCapacity	getInitializedAttributes()
private RecordEventsSpanImpl.TraceEvents<Link>	getInitializedLinks()
private RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<MessageEvent>>	getInitializedNetworkEvents()
Span.Kind	getKind()	Returns the kind of this Span.
long	getLatencyNs()	Returns the latency of the Span in nanos.
String	getName()	Returns the name of the Span.
RecordEventsSpanImpl	getNext()	Returns a reference to the next element in the list.
RecordEventsSpanImpl	getPrev()	Returns a reference to the previous element in the list.
boolean	getSampleToLocalSpanStore()	Returns if the name of this Span must be register to the SampledSpanStore.
Status	getStatus()	Returns the status of the Span.
private Status	getStatusWithDefault()
(package private) TimestampConverter	getTimestampConverter()	Returns the TimestampConverter used by this Span.
void	putAttribute(String key, AttributeValue value)	Sets an attribute to the Span.
void	putAttributes(Map<String, AttributeValue> attributes)	Sets a set of attributes to the Span.
void	setNext(RecordEventsSpanImpl element)	Sets the reference to the next element in the list.
void	setPrev(RecordEventsSpanImpl element)	Sets the reference to the previous element in the list.
void	setStatus(Status status)	Sets the Status to the Span.
static RecordEventsSpanImpl	startSpan(SpanContext context, String name, Span.Kind kind, SpanId parentSpanId, Boolean hasRemoteParent, TraceParams traceParams, RecordEventsSpanImpl.StartEndHandler startEndHandler, TimestampConverter timestampConverter, Clock clock)	Creates and starts a span with the given configuration.
SpanData	toSpanData()	Returns an immutable representation of all the data from this Span.

Methods inherited from class Span

addAnnotation, addAttributes, addNetworkEvent, end, getContext, getOptions

Methods inherited from class Object

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

Field Details

logger

private static final Logger logger

RECORD_EVENTS_SPAN_OPTIONS

private static final EnumSet<Span.Options> RECORD_EVENTS_SPAN_OPTIONS

parentSpanId

@Nullable
private final SpanId parentSpanId

hasRemoteParent

@Nullable
private final Boolean hasRemoteParent

traceParams

private final TraceParams traceParams

startEndHandler

private final RecordEventsSpanImpl.StartEndHandler startEndHandler

name

private final String name

kind

@Nullable
private final Span.Kind kind

clock

private final Clock clock

timestampConverter

private final TimestampConverter timestampConverter

startNanoTime

private final long startNanoTime

attributes

@Nullable
private RecordEventsSpanImpl.AttributesWithCapacity attributes

annotations

@Nullable
private RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<Annotation>> annotations

messageEvents

@Nullable
private RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<MessageEvent>> messageEvents

links

@Nullable
private RecordEventsSpanImpl.TraceEvents<Link> links

numberOfChildren

private int numberOfChildren

status

@Nullable
private Status status

endNanoTime

private long endNanoTime

hasBeenEnded

private boolean hasBeenEnded

sampleToLocalSpanStore

private boolean sampleToLocalSpanStore

next

@Nullable
private RecordEventsSpanImpl next

prev

@Nullable
private RecordEventsSpanImpl prev

Constructor Details

RecordEventsSpanImpl

private RecordEventsSpanImpl(SpanContext context,
 String name,
 @Nullable
 Span.Kind kind,
 @Nullable
 SpanId parentSpanId,
 @Nullable
 Boolean hasRemoteParent,
 TraceParams traceParams,
 RecordEventsSpanImpl.StartEndHandler startEndHandler,
 @Nullable
 TimestampConverter timestampConverter,
 Clock clock)

Method Details

startSpan

public static RecordEventsSpanImpl startSpan(SpanContext context,
 String name,
 @Nullable
 Span.Kind kind,
 @Nullable
 SpanId parentSpanId,
 @Nullable
 Boolean hasRemoteParent,
 TraceParams traceParams,
 RecordEventsSpanImpl.StartEndHandler startEndHandler,
 @Nullable
 TimestampConverter timestampConverter,
 Clock clock)

Creates and starts a span with the given configuration.

Parameters:

context - supplies the trace_id and span_id for the newly started span.

name - the displayed name for the new span.

parentSpanId - the span_id of the parent span, or null if the new span is a root span.

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

traceParams - trace parameters like sampler and probability.

startEndHandler - handler called when the span starts and ends.

timestampConverter - null if the span is a root span or the parent is not sampled. If the parent is sampled, we should use the same converter to ensure ordering between tracing events.

clock - the clock used to get the time.

Returns:

a new and started span.

getName

public String getName()

Returns the name of the Span.

Returns:

the name of the Span.

getStatus

public Status getStatus()

Returns the status of the Span. If not set defaults to Status.OK.

Returns:

the status of the Span.

getEndNanoTime

public long getEndNanoTime()

Returns the end nano time (see System.nanoTime()). If the current Span is not ended then returns Clock.nowNanos().

Returns:

the end nano time.

getLatencyNs

public long getLatencyNs()

Returns the latency of the Span in nanos. If still active then returns now() - start time.

Returns:

the latency of the Span in nanos.

getSampleToLocalSpanStore

public boolean getSampleToLocalSpanStore()

Returns if the name of this Span must be register to the SampledSpanStore.

Returns:

if the name of this Span must be register to the SampledSpanStore.

getKind

@Nullable
public Span.Kind getKind()

Returns the kind of this Span.

Returns:

the kind of this Span.

getTimestampConverter

@Nullable
TimestampConverter getTimestampConverter()

Returns the TimestampConverter used by this Span.

Returns:

the TimestampConverter used by this Span.

toSpanData

public SpanData toSpanData()

Returns an immutable representation of all the data from this Span.

Returns:

an immutable representation of all the data from this Span.

Throws:

IllegalStateException - if the Span doesn't have RECORD_EVENTS option.

putAttribute

public void putAttribute(String key,
 AttributeValue value)

Description copied from class: Span

Sets an attribute to the Span. If the Span previously contained a mapping for the key, the old value is replaced by the specified value.

Overrides:

putAttribute in class Span

Parameters:

key - the key for this attribute.

value - the value for this attribute.

putAttributes

public void putAttributes(Map<String, AttributeValue> attributes)

Description copied from class: Span

Sets a set of attributes to the Span. The effect of this call is equivalent to that of calling Span.putAttribute(String, AttributeValue) once for each element in the specified map.

Overrides:

putAttributes in class Span

Parameters:

attributes - the attributes that will be added and associated with the Span.

addAnnotation

public void addAnnotation(String description,
 Map<String, AttributeValue> attributes)

Description copied from class: Span

Adds an annotation to the Span.

Specified by:

addAnnotation in class Span

Parameters:

description - the description of the annotation time event.

attributes - the attributes that will be added; these are associated with this annotation, not the Span as for Span.putAttributes(Map).

addAnnotation

public void addAnnotation(Annotation annotation)

Description copied from class: Span

Adds an annotation to the Span.

Specified by:

addAnnotation in class Span

Parameters:

annotation - the annotations to add.

addMessageEvent

public void addMessageEvent(MessageEvent messageEvent)

Description copied from class: Span

Adds a MessageEvent to the Span.

This function can be used by higher level applications to record messaging event.

This method should always be overridden by users whose API versions are larger or equal to 0.12.

Overrides:

addMessageEvent in class Span

Parameters:

messageEvent - the message to add.

addLink

public void addLink(Link link)

Description copied from class: Span

Adds a Link to the Span.

Used (for example) in batching operations, where a single batch handler processes multiple requests from different traces.

Specified by:

addLink in class Span

Parameters:

link - the link to add.

setStatus

public void setStatus(Status status)

Description copied from class: Span

Sets the Status to the Span.

If used, this will override the default Span status. Default is Status.OK.

Only the value of the last call will be recorded, and implementations are free to ignore previous calls. If the status is set via EndSpanOptions.Builder.setStatus(Status) that will always be the last call.

Overrides:

setStatus in class Span

Parameters:

status - the Status to set.

end

public void end(EndSpanOptions options)

Description copied from class: Span

Marks the end of Span execution with the given options.

Only the timing of the first end call for a given Span will be recorded, and implementations are free to ignore all further calls.

Specified by:

end in class Span

Parameters:

options - the options to be used for the end of the Span.

addChild

void addChild()

getInitializedAttributes

private RecordEventsSpanImpl.AttributesWithCapacity getInitializedAttributes()

getInitializedAnnotations

private RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<Annotation>> getInitializedAnnotations()

getInitializedNetworkEvents

private RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<MessageEvent>> getInitializedNetworkEvents()

getInitializedLinks

private RecordEventsSpanImpl.TraceEvents<Link> getInitializedLinks()

getStatusWithDefault

private Status getStatusWithDefault()

createTimedEvents

private static <T> SpanData.TimedEvents<T> createTimedEvents(RecordEventsSpanImpl.TraceEvents<RecordEventsSpanImpl.EventWithNanoTime<T>> events,
 TimestampConverter timestampConverter)

getNext

@Nullable
public RecordEventsSpanImpl getNext()

Description copied from interface: ConcurrentIntrusiveList.Element

Returns a reference to the next element in the list.

Specified by:

getNext in interface ConcurrentIntrusiveList.Element<RecordEventsSpanImpl>

Returns:

a reference to the next element in the list.

setNext

public void setNext(@Nullable
 RecordEventsSpanImpl element)

Description copied from interface: ConcurrentIntrusiveList.Element

Sets the reference to the next element in the list.

Specified by:

setNext in interface ConcurrentIntrusiveList.Element<RecordEventsSpanImpl>

Parameters:

element - the reference to the next element in the list.

getPrev

@Nullable
public RecordEventsSpanImpl getPrev()

Description copied from interface: ConcurrentIntrusiveList.Element

Returns a reference to the previous element in the list.

Specified by:

getPrev in interface ConcurrentIntrusiveList.Element<RecordEventsSpanImpl>

Returns:

a reference to the previous element in the list.

setPrev

public void setPrev(@Nullable
 RecordEventsSpanImpl element)

Description copied from interface: ConcurrentIntrusiveList.Element

Sets the reference to the previous element in the list.

Specified by:

setPrev in interface ConcurrentIntrusiveList.Element<RecordEventsSpanImpl>

Parameters:

element - the reference to the previous element in the list.