BlankSpan (openconsensus-api 0.1.0-SNAPSHOT API)

java.lang.Object
- openconsensus.trace.BlankSpan

All Implemented Interfaces:

Span
```
@Immutable
public final class BlankSpan
extends Object
implements 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(openconsensus.trace.Span).

Since:

0.1.0

Nested Class Summary
- Nested classes/interfaces inherited from interface openconsensus.trace.Span
  Span.Builder, Span.Kind

Field Summary

Fields
Modifier and Type Field and Description

static Span INSTANCE
Singleton instance of this class.

Fields
Modifier and Type	Field and Description
`static Span`	`INSTANCE` Singleton instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEvent(Event event)` Adds an event to the `Span`.
`void`	`addEvent(String name)` Adds an event to the `Span`.
`void`	`addEvent(String name, Map<String,AttributeValue> attributes)` Adds an event to the `Span`.
`void`	`addLink(Link link)` Adds a `Link` to the `Span`.
`void`	`end()` Marks the end of `Span` execution with the default options.
`SpanContext`	`getContext()` Returns the `SpanContext` associated with this `Span`.
`boolean`	`isRecordingEvents()` Returns `true` if this `Span` records events (e.g, `Span.addEvent(String)`.
`void`	`setAttribute(String key, AttributeValue value)` Sets an attribute to the `Span`.
`void`	`setAttribute(String key, boolean value)` Sets an attribute to the `Span`.
`void`	`setAttribute(String key, double value)` Sets an attribute to the `Span`.
`void`	`setAttribute(String key, long value)` Sets an attribute to the `Span`.
`void`	`setAttribute(String key, String value)` Sets an attribute to the `Span`.
`void`	`setStatus(Status status)` Sets the `Status` to the `Span`.
`String`	`toString()`
`void`	`updateName(String name)` Updates the `Span` name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final Span INSTANCE
```
    Singleton instance of this class.
    
    Since:
    
    0.1.0
- Method Detail
  - setAttribute
```
public void setAttribute(String key,
                         String value)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setAttribute in interface Span
    
    Parameters:
    
    key - the key for this attribute.
    
    value - the value for this attribute.
  - setAttribute
```
public void setAttribute(String key,
                         long value)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setAttribute in interface Span
    
    Parameters:
    
    key - the key for this attribute.
    
    value - the value for this attribute.
  - setAttribute
```
public void setAttribute(String key,
                         double value)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setAttribute in interface Span
    
    Parameters:
    
    key - the key for this attribute.
    
    value - the value for this attribute.
  - setAttribute
```
public void setAttribute(String key,
                         boolean value)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setAttribute in interface Span
    
    Parameters:
    
    key - the key for this attribute.
    
    value - the value for this attribute.
  - setAttribute
```
public void setAttribute(String key,
                         AttributeValue value)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setAttribute in interface Span
    
    Parameters:
    
    key - the key for this attribute.
    
    value - the value for this attribute.
  - addEvent
```
public void addEvent(String name)
```
    Description copied from interface: Span
    
    Adds an event to the Span.
    
    Specified by:
    
    addEvent in interface Span
    
    Parameters:
    
    name - the name of the event.
  - addEvent
```
public void addEvent(String name,
                     Map<String,AttributeValue> attributes)
```
    Description copied from interface: Span
    
    Adds an event to the Span.
    
    Specified by:
    
    addEvent in interface Span
    
    Parameters:
    
    name - the name of the event.
    
    attributes - the attributes that will be added; these are associated with this event, not the Span as for setAttributes().
  - addEvent
```
public void addEvent(Event event)
```
    Description copied from interface: Span
    
    Adds an event to the Span.
    
    Specified by:
    
    addEvent in interface Span
    
    Parameters:
    
    event - the event to add.
  - addLink
```
public void addLink(Link link)
```
    Description copied from interface: 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 interface Span
    
    Parameters:
    
    link - the link to add.
  - setStatus
```
public void setStatus(Status status)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setStatus in interface Span
    
    Parameters:
    
    status - the Status to set.
  - updateName
```
public void updateName(String name)
```
    Description copied from interface: Span
    
    Updates the Span name.
    If used, this will override the name provided via Span.Builder.
    Upon this update, any sampling behavior based on Span name will depend on the implementation.
    
    Specified by:
    
    updateName in interface Span
    
    Parameters:
    
    name - the Span name.
  - end
```
public void end()
```
    Description copied from interface: Span
    
    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.
    
    Specified by:
    
    end in interface Span
  - getContext
```
public SpanContext getContext()
```
    Description copied from interface: Span
    
    Returns the SpanContext associated with this Span.
    
    Specified by:
    
    getContext in interface Span
    
    Returns:
    
    the SpanContext associated with this Span.
  - isRecordingEvents
```
public boolean isRecordingEvents()
```
    Description copied from interface: Span
    
    Returns true if this Span records events (e.g, Span.addEvent(String).
    
    Specified by:
    
    isRecordingEvents in interface Span
    
    Returns:
    
    true if this Span records events.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BlankSpan

Nested Class Summary

Nested classes/interfaces inherited from interface openconsensus.trace.Span

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

Method Detail

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

addEvent

addEvent

addEvent

addLink

setStatus

updateName

end

getContext

isRecordingEvents

toString