DefaultSpan (opentelemetry-api 0.9.1 API)

java.lang.Object
- io.opentelemetry.trace.DefaultSpan

All Implemented Interfaces:

Span
```
@Immutable
public final class DefaultSpan
extends Object
implements Span
```
The DefaultSpan is the default Span that is used when no Span implementation is available. All operations are no-op except context propagation.
Used also to stop tracing, see Tracer.withSpan(io.opentelemetry.trace.Span).

Since:

0.1.0

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEvent(String name)` Adds an event to the `Span`.
`void`	`addEvent(String name, Attributes attributes)` Adds an event to the `Span` with the given `Attributes`.
`void`	`addEvent(String name, Attributes attributes, long timestamp)` Adds an event to the `Span` with the given `Attributes` and `timestamp`.
`void`	`addEvent(String name, long timestamp)` Adds an event to the `Span` with the given `timestamp`, as nanos since epoch.
`static Span`	`create(SpanContext spanContext)` Creates an instance of this class with the `SpanContext`.
`void`	`end()` Marks the end of `Span` execution.
`void`	`end(EndSpanOptions endOptions)` Marks the end of `Span` execution with the specified `EndSpanOptions`.
`SpanContext`	`getContext()` Returns the `SpanContext` associated with this `Span`.
`static Span`	`getInvalid()` Returns a `DefaultSpan` with an invalid `SpanContext`.
`boolean`	`isRecording()` Returns `true` if this `Span` records tracing events (e.g.
`void`	`recordException(Throwable exception)` Records information about the `Throwable` to the `Span`.
`void`	`recordException(Throwable exception, Attributes additionalAttributes)` Records information about the `Throwable` to the `Span`.
`<T> void`	`setAttribute(AttributeKey<T> key, T 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(StatusCanonicalCode canonicalCode)` Sets the status to the `Span`.
`void`	`setStatus(StatusCanonicalCode canonicalCode, String description)` 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

Methods inherited from interface io.opentelemetry.trace.Span
setAttribute

- Method Detail
  - getInvalid
```
public static Span getInvalid()
```
    Returns a DefaultSpan with an invalid SpanContext.
    
    Returns:
    
    a DefaultSpan with an invalid SpanContext.
    
    Since:
    
    0.1.0
  - create
```
public static Span create(SpanContext spanContext)
```
    Creates an instance of this class with the SpanContext.
    
    Parameters:
    
    spanContext - the SpanContext.
    
    Returns:
    
    a DefaultSpan.
    
    Since:
    
    0.1.0
  - 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.
    If a null or empty String value is passed in, the behavior is undefined, and hence strongly discouraged.
    Note: It is strongly recommended to use Span.setAttribute(AttributeKey, Object), and pre-allocate your keys, if possible.
    
    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.
    Note: It is strongly recommended to use Span.setAttribute(AttributeKey, Object), and pre-allocate your keys, if possible.
    
    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.
    Note: It is strongly recommended to use Span.setAttribute(AttributeKey, Object), and pre-allocate your keys, if possible.
    
    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.
    Note: It is strongly recommended to use Span.setAttribute(AttributeKey, Object), and pre-allocate your keys, if possible.
    
    Specified by:
    
    setAttribute in interface Span
    
    Parameters:
    
    key - the key for this attribute.
    
    value - the value for this attribute.
  - setAttribute
```
public <T> void setAttribute(AttributeKey<T> key,
                             T 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.
    Note: the behavior of null values is undefined, and hence strongly discouraged.
    
    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. The timestamp of the event will be the current time.
    
    Specified by:
    
    addEvent in interface Span
    
    Parameters:
    
    name - the name of the event.
  - addEvent
```
public void addEvent(String name,
                     long timestamp)
```
    Description copied from interface: Span
    
    Adds an event to the Span with the given timestamp, as nanos since epoch. Note, this timestamp is not the same as System.nanoTime() but may be computed using it, for example, by taking a difference of readings from System.nanoTime() and adding to the span start time.
    When possible, it is preferred to use Span.addEvent(String) at the time the event occurred.
    
    Specified by:
    
    addEvent in interface Span
    
    Parameters:
    
    name - the name of the event.
    
    timestamp - the explicit event timestamp in nanos since epoch.
  - addEvent
```
public void addEvent(String name,
                     Attributes attributes)
```
    Description copied from interface: Span
    
    Adds an event to the Span with the given Attributes. The timestamp of the event will be the current time.
    
    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 setAttribute().
  - addEvent
```
public void addEvent(String name,
                     Attributes attributes,
                     long timestamp)
```
    Description copied from interface: Span
    
    Adds an event to the Span with the given Attributes and timestamp. Note, this timestamp is not the same as System.nanoTime() but may be computed using it, for example, by taking a difference of readings from System.nanoTime() and adding to the span start time.
    When possible, it is preferred to use Span.addEvent(String) at the time the event occurred.
    
    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 setAttribute().
    
    timestamp - the explicit event timestamp in nanos since epoch.
  - setStatus
```
public void setStatus(StatusCanonicalCode canonicalCode)
```
    Description copied from interface: Span
    
    Sets the status to the Span.
    If used, this will override the default Span status. Default status code is StatusCanonicalCode.UNSET.
    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:
    
    canonicalCode - the StatusCanonicalCode to set.
  - setStatus
```
public void setStatus(StatusCanonicalCode canonicalCode,
                      String description)
```
    Description copied from interface: Span
    
    Sets the status to the Span.
    If used, this will override the default Span status. Default status code is StatusCanonicalCode.UNSET.
    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:
    
    canonicalCode - the StatusCanonicalCode to set.
    
    description - the description of the Status.
  - recordException
```
public void recordException(Throwable exception)
```
    Description copied from interface: Span
    
    Records information about the Throwable to the Span.
    Note that SemanticAttributes.EXCEPTION_ESCAPED cannot be determined by this function. You should record this attribute manually using Span.recordException(Throwable, Attributes) if you know that an exception is escaping.
    
    Specified by:
    
    recordException in interface Span
    
    Parameters:
    
    exception - the Throwable to record.
  - recordException
```
public void recordException(Throwable exception,
                            Attributes additionalAttributes)
```
    Description copied from interface: Span
    
    Records information about the Throwable to the Span.
    
    Specified by:
    
    recordException in interface Span
    
    Parameters:
    
    exception - the Throwable to record.
    
    additionalAttributes - the additional Attributes to record.
  - 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.
    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
  - end
```
public void end(EndSpanOptions endOptions)
```
    Description copied from interface: Span
    
    Marks the end of Span execution with the specified EndSpanOptions.
    Only the timing of the first end call for a given Span will be recorded, and implementations are free to ignore all further calls.
    Use this method for specifying explicit end options, such as end Timestamp. When no explicit values are required, use Span.end().
    
    Specified by:
    
    end in interface Span
    
    Parameters:
    
    endOptions - the explicit EndSpanOptions for this 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.
  - isRecording
```
public boolean isRecording()
```
    Description copied from interface: Span
    
    Returns true if this Span records tracing events (e.g. Span.addEvent(String), Span.setAttribute(String, long)).
    
    Specified by:
    
    isRecording in interface Span
    
    Returns:
    
    true if this Span records tracing events.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DefaultSpan

Nested Class Summary

Nested classes/interfaces inherited from interface io.opentelemetry.trace.Span

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.opentelemetry.trace.Span

Method Detail

getInvalid

create

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

addEvent

addEvent

addEvent

addEvent

setStatus

setStatus

recordException

recordException

updateName

end

end

getContext

isRecording

toString