com.google.instrumentation.trace

Class Span

java.lang.Object

com.google.instrumentation.trace.Span

Direct Known Subclasses:

BlankSpan

public abstract class Span
extends Object

An abstract class that represents a span. It has an associated SpanContext and a set of Span.Options.

Spans are created by the SpanBuilder.startSpan() method.

Span must be ended by calling end() or end(EndSpanOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Span.Options Span options.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Span(SpanContext context, EnumSet<Span.Options> options) Creates a new Span.

Method Summary

Modifier and Type	Method and Description
abstract void	addAnnotation(Annotation annotation) Adds an annotation to the Span.
void	addAnnotation(String description) Adds an annotation to the Span.
abstract void	addAnnotation(String description, Map<String,AttributeValue> attributes) Adds an annotation to the Span.
abstract void	addAttributes(Map<String,AttributeValue> attributes) Adds a set of attributes to the Span.
abstract void	addLink(Link link) Adds a Link to the Span.
abstract void	addNetworkEvent(NetworkEvent networkEvent) Adds a NetworkEvent to the Span.
void	end() Marks the end of Span execution with the default options.
abstract void	end(EndSpanOptions options) Marks the end of Span execution with the given options.
SpanContext	getContext() Returns the SpanContext associated with this Span.
Set<Span.Options>	getOptions() Returns the options associated with this Span.

Methods inherited from class java.lang.Object

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

Constructor Detail

Span

protected Span(SpanContext context,
               @Nullable
               EnumSet<Span.Options> options)

Creates a new Span.

Parameters:

context - the context associated with this Span.

options - the options associated with this Span. If null then default options will be set.

Throws:

NullPointerException - if context is null.

IllegalArgumentException - if the SpanContext is sampled but no RECORD_EVENTS options.

Method Detail

addAttributes

public abstract void addAttributes(Map<String,AttributeValue> attributes)

Adds a set of attributes to the Span.

Parameters:

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

addAnnotation

public final void addAnnotation(String description)

Adds an annotation to the Span.

Parameters:

description - the description of the annotation time event.

addAnnotation

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

Adds an annotation to the 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 addAttributes(java.util.Map<java.lang.String, com.google.instrumentation.trace.AttributeValue>).

addAnnotation

public abstract void addAnnotation(Annotation annotation)

Adds an annotation to the Span.

Parameters:

annotation - the annotations to add.

addNetworkEvent

public abstract void addNetworkEvent(NetworkEvent networkEvent)

Adds a NetworkEvent to the Span.

This function is only intended to be used by RPC systems (either client or server), not by higher level applications.

Parameters:

networkEvent - the network event to add.

addLink

public abstract void addLink(Link link)

Adds a Link to the Span.

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

Parameters:

link - the link to add.

end

public abstract void end(EndSpanOptions options)

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.

Parameters:

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

end

public final void end()

Marks the end of Span execution with the default 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.

getContext

public final SpanContext getContext()

Returns the SpanContext associated with this Span.

Returns:

the SpanContext associated with this Span.

getOptions

public final Set<Span.Options> getOptions()

Returns the options associated with this Span.

Returns:

the options associated with this Span.