Class BlankSpan

java.lang.Object

io.opencensus.trace.Span

io.opencensus.trace.BlankSpan

@Immutable
public final class BlankSpan
extends Span

The BlankSpan is a singleton class, which is the default Span that is used when no Span implementation is available. All operations are no-op.

Used also to stop tracing, see Tracer.withSpan(Span).

Since:

0.5

Nested Class Summary

Nested classes/interfaces inherited from class Span

Span.Kind, Span.Options

Field Summary

Fields

Modifier and Type	Field	Description
static final BlankSpan	INSTANCE	Singleton instance of this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BlankSpan()

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(Annotation annotation)	No-op implementation of the Span.addAnnotation(Annotation) method.
void	addAnnotation(String description, Map<String, AttributeValue> attributes)	No-op implementation of the Span.addAnnotation(String, Map) method.
void	addLink(Link link)	No-op implementation of the Span.addLink(Link) method.
void	addMessageEvent(MessageEvent messageEvent)	No-op implementation of the Span.addMessageEvent(MessageEvent) method.
void	addNetworkEvent(NetworkEvent networkEvent)	Deprecated.
void	end(EndSpanOptions options)	No-op implementation of the Span.end(EndSpanOptions) method.
void	putAttribute(String key, AttributeValue value)	No-op implementation of the Span.putAttribute(String, AttributeValue) method.
void	putAttributes(Map<String, AttributeValue> attributes)	No-op implementation of the Span.putAttributes(Map) method.
void	setStatus(Status status)	Sets the Status to the Span.
String	toString()

Methods inherited from class Span

addAnnotation, addAttributes, end, getContext, getOptions

Methods inherited from class Object

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

Field Details

INSTANCE

public static final BlankSpan INSTANCE

Singleton instance of this class.

Since:

0.5

Constructor Details

BlankSpan

private BlankSpan()

Method Details

putAttribute

public void putAttribute(String key,
 AttributeValue value)

No-op implementation of the Span.putAttribute(String, AttributeValue) method.

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)

No-op implementation of the Span.putAttributes(Map) method.

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)

No-op implementation of the Span.addAnnotation(String, Map) method.

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)

No-op implementation of the Span.addAnnotation(Annotation) method.

Specified by:

addAnnotation in class Span

Parameters:

annotation - the annotations to add.

addNetworkEvent

@Deprecated
public void addNetworkEvent(NetworkEvent networkEvent)

Deprecated.

No-op implementation of the Span.addNetworkEvent(NetworkEvent) method.

Overrides:

addNetworkEvent in class Span

Parameters:

networkEvent - the network event to add.

addMessageEvent

public void addMessageEvent(MessageEvent messageEvent)

No-op implementation of the Span.addMessageEvent(MessageEvent) method.

Overrides:

addMessageEvent in class Span

Parameters:

messageEvent - the message to add.

addLink

public void addLink(Link link)

No-op implementation of the Span.addLink(Link) method.

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)

No-op implementation of the Span.end(EndSpanOptions) method.

Specified by:

end in class Span

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object