io.opencensus.implcore.trace

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 io.opencensus.trace.Span
implements ConcurrentIntrusiveList.Element<RecordEventsSpanImpl>

Implementation for the Span class that records trace events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecordEventsSpanImpl.StartEndHandler Interface to handle the start and end operations for a Span only when the Span has Options#RECORD_EVENTS option.

Nested classes/interfaces inherited from class io.opencensus.trace.Span

io.opencensus.trace.Span.Kind, io.opencensus.trace.Span.Options

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(io.opencensus.trace.Annotation annotation)
void	addAnnotation(String description, Map<String,io.opencensus.trace.AttributeValue> attributes)
void	addLink(io.opencensus.trace.Link link)
void	addMessageEvent(io.opencensus.trace.MessageEvent messageEvent)
void	end(io.opencensus.trace.EndSpanOptions options)
long	getEndNanoTime() Returns the end nano time (see System.nanoTime()).
io.opencensus.trace.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.
io.opencensus.trace.Status	getStatus() Returns the status of the Span.
void	putAttribute(String key, io.opencensus.trace.AttributeValue value)
void	putAttributes(Map<String,io.opencensus.trace.AttributeValue> attributes)
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(io.opencensus.trace.Status status)
static RecordEventsSpanImpl	startSpan(io.opencensus.trace.SpanContext context, String name, io.opencensus.trace.Span.Kind kind, io.opencensus.trace.SpanId parentSpanId, Boolean hasRemoteParent, io.opencensus.trace.config.TraceParams traceParams, RecordEventsSpanImpl.StartEndHandler startEndHandler, TimestampConverter timestampConverter, io.opencensus.common.Clock clock) Creates and starts a span with the given configuration.
io.opencensus.trace.export.SpanData	toSpanData() Returns an immutable representation of all the data from this Span.

Methods inherited from class io.opencensus.trace.Span

addAnnotation, addAttributes, addNetworkEvent, end, getContext, getOptions

Methods inherited from class java.lang.Object

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

Method Detail

startSpan

public static RecordEventsSpanImpl startSpan(io.opencensus.trace.SpanContext context,
                                             String name,
                                             @Nullable
                                             io.opencensus.trace.Span.Kind kind,
                                             @Nullable
                                             io.opencensus.trace.SpanId parentSpanId,
                                             @Nullable
                                             Boolean hasRemoteParent,
                                             io.opencensus.trace.config.TraceParams traceParams,
                                             RecordEventsSpanImpl.StartEndHandler startEndHandler,
                                             @Nullable
                                             TimestampConverter timestampConverter,
                                             io.opencensus.common.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 io.opencensus.trace.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 io.opencensus.trace.Span.Kind getKind()

Returns the kind of this Span.

Returns:

the kind of this Span.

toSpanData

public io.opencensus.trace.export.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,
                         io.opencensus.trace.AttributeValue value)

Overrides:

putAttribute in class io.opencensus.trace.Span

putAttributes

public void putAttributes(Map<String,io.opencensus.trace.AttributeValue> attributes)

Overrides:

putAttributes in class io.opencensus.trace.Span

addAnnotation

public void addAnnotation(String description,
                          Map<String,io.opencensus.trace.AttributeValue> attributes)

Specified by:

addAnnotation in class io.opencensus.trace.Span

addAnnotation

public void addAnnotation(io.opencensus.trace.Annotation annotation)

Specified by:

addAnnotation in class io.opencensus.trace.Span

addMessageEvent

public void addMessageEvent(io.opencensus.trace.MessageEvent messageEvent)

Overrides:

addMessageEvent in class io.opencensus.trace.Span

addLink

public void addLink(io.opencensus.trace.Link link)

Specified by:

addLink in class io.opencensus.trace.Span

setStatus

public void setStatus(io.opencensus.trace.Status status)

Overrides:

setStatus in class io.opencensus.trace.Span

end

public void end(io.opencensus.trace.EndSpanOptions options)

Specified by:

end in class io.opencensus.trace.Span

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.