io.opencensus.trace

Class SpanImpl

java.lang.Object

io.opencensus.trace.Span

io.opencensus.trace.SpanImpl

All Implemented Interfaces:

io.opencensus.trace.internal.ConcurrentIntrusiveList.Element<SpanImpl>

@ThreadSafe
public final class SpanImpl
extends io.opencensus.trace.Span
implements io.opencensus.trace.internal.ConcurrentIntrusiveList.Element<SpanImpl>

Implementation for the Span class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpanImpl.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.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	addAttributes(Map<String,io.opencensus.trace.AttributeValue> attributes)
void	addLink(io.opencensus.trace.Link link)
void	addNetworkEvent(io.opencensus.trace.NetworkEvent networkEvent)
void	end(io.opencensus.trace.EndSpanOptions options)
long	getEndNanoTime() Returns the end nano time (see System.nanoTime()).
long	getLatencyNs() Returns the latency of the Span in nanos.
String	getName() Returns the name of the Span.
SpanImpl	getNext()
SpanImpl	getPrev()
io.opencensus.trace.Status	getStatus() Returns the status of the Span.
void	setNext(SpanImpl element)
void	setPrev(SpanImpl element)
static SpanImpl	startSpan(io.opencensus.trace.SpanContext context, EnumSet<io.opencensus.trace.Span.Options> options, String name, io.opencensus.trace.SpanId parentSpanId, Boolean hasRemoteParent, io.opencensus.trace.config.TraceParams traceParams, SpanImpl.StartEndHandler startEndHandler, io.opencensus.internal.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, 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 SpanImpl startSpan(io.opencensus.trace.SpanContext context,
                                 @Nullable
                                 EnumSet<io.opencensus.trace.Span.Options> options,
                                 String name,
                                 @Nullable
                                 io.opencensus.trace.SpanId parentSpanId,
                                 @Nullable
                                 Boolean hasRemoteParent,
                                 io.opencensus.trace.config.TraceParams traceParams,
                                 SpanImpl.StartEndHandler startEndHandler,
                                 @Nullable
                                 io.opencensus.internal.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.

options - the options for the new span, importantly Options.RECORD_EVENTS.

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.

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.

addAttributes

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

Specified by:

addAttributes 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

addNetworkEvent

public void addNetworkEvent(io.opencensus.trace.NetworkEvent networkEvent)

Specified by:

addNetworkEvent in class io.opencensus.trace.Span

addLink

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

Specified by:

addLink 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

public SpanImpl getNext()

Specified by:

getNext in interface io.opencensus.trace.internal.ConcurrentIntrusiveList.Element<SpanImpl>

setNext

public void setNext(SpanImpl element)

Specified by:

setNext in interface io.opencensus.trace.internal.ConcurrentIntrusiveList.Element<SpanImpl>

getPrev

public SpanImpl getPrev()

Specified by:

getPrev in interface io.opencensus.trace.internal.ConcurrentIntrusiveList.Element<SpanImpl>

setPrev

public void setPrev(SpanImpl element)

Specified by:

setPrev in interface io.opencensus.trace.internal.ConcurrentIntrusiveList.Element<SpanImpl>