ActiveSpanShim (io.opentracing:opentracing-v030 0.0.4 API)

java.lang.Object
- io.opentracing.v_030.shim.ActiveSpanShim

All Implemented Interfaces:

ActiveSpan, BaseSpan<ActiveSpan>, SpanWrapper, Closeable, AutoCloseable
```
public class ActiveSpanShim
extends Object
implements ActiveSpan, SpanWrapper
```

Nested Class Summary
- Nested classes/interfaces inherited from interface io.opentracing.v_030.ActiveSpan
  ActiveSpan.Continuation

Constructor Summary

Constructors
Modifier Constructor and Description

protected ActiveSpanShim(io.opentracing.Scope scope)

Constructors
Modifier	Constructor and Description
`protected`	`ActiveSpanShim(io.opentracing.Scope scope)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActiveSpan.Continuation`	`capture()` "Capture" a new `ActiveSpan.Continuation` associated with this `ActiveSpan` and `Span`, as well as any 3rd-party execution context of interest.
`void`	`close()` A synonym for `ActiveSpan.deactivate()` that can be used in try-with-resources blocks.
`SpanContext`	`context()` Retrieve the associated SpanContext.
`void`	`deactivate()` Mark the end of the active period for the current thread and `ActiveSpan`.
`boolean`	`equals(Object obj)`
`String`	`getBaggageItem(String key)`
`ActiveSpanShim`	`log(long timestampMicros, Map<String,?> fields)` Like log(Map<String, Object>), but with an explicit timestamp.
`ActiveSpanShim`	`log(long timestampMicroseconds, String event)` Record an event at a specific timestamp.
`ActiveSpanShim`	`log(Map<String,?> fields)` Log key:value pairs to the Span with the current walltime timestamp.
`ActiveSpanShim`	`log(String event)` Record an event at the current walltime timestamp.
`protected io.opentracing.Scope`	`scope()`
`ActiveSpanShim`	`setBaggageItem(String key, String value)` Sets a baggage item in the Span (and its SpanContext) as a key/value pair.
`ActiveSpanShim`	`setOperationName(String operationName)` Sets the string name for the logical operation this span represents.
`ActiveSpanShim`	`setTag(String key, boolean value)` Same as `BaseSpan.setTag(String, String)`, but for boolean values.
`ActiveSpanShim`	`setTag(String key, Number value)` Same as `BaseSpan.setTag(String, String)`, but for numeric values.
`ActiveSpanShim`	`setTag(String key, String value)` Set a key:value tag on the Span.
`io.opentracing.Span`	`span()`
`String`	`toString()`

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

- Constructor Detail
  - ActiveSpanShim
```
protected ActiveSpanShim(io.opentracing.Scope scope)
```
- Method Detail
  - scope
```
protected io.opentracing.Scope scope()
```
  - span
```
public io.opentracing.Span span()
```
    Specified by:
    
    span in interface SpanWrapper
  - deactivate
```
public void deactivate()
```
    Description copied from interface: ActiveSpan
    
    Mark the end of the active period for the current thread and ActiveSpan. When the last ActiveSpan is deactivated for a given Span, it is automatically Span.finish()ed.
    NOTE: Calling ActiveSpan.deactivate() more than once on a single ActiveSpan instance leads to undefined behavior.
    
    Specified by:
    
    deactivate in interface ActiveSpan
    
    See Also:
    
    {@link ActiveSpan}s are auto-closeable and may be used in try-with-resources blocks
  - close
```
public void close()
```
    Description copied from interface: ActiveSpan
    
    A synonym for ActiveSpan.deactivate() that can be used in try-with-resources blocks.
    
    Specified by:
    
    close in interface ActiveSpan
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - capture
```
public ActiveSpan.Continuation capture()
```
    Description copied from interface: ActiveSpan
    
    "Capture" a new ActiveSpan.Continuation associated with this ActiveSpan and Span, as well as any 3rd-party execution context of interest. The ActiveSpan.Continuation may be used as data in a closure or callback function where the ActiveSpan may be resumed and reactivated.
    IMPORTANT: the caller MUST ActiveSpan.Continuation.activate() and ActiveSpan.deactivate() the returned ActiveSpan.Continuation or the associated Span will never automatically Span.finish(). That is, calling ActiveSpan.capture() increments a refcount that must be decremented somewhere else.
    The associated Span will not Span.finish() while a ActiveSpan.Continuation is outstanding; in this way, it provides a reference/pin just like an ActiveSpan does.
    
    Specified by:
    
    capture in interface ActiveSpan
    
    Returns:
    
    a new ActiveSpan.Continuation to ActiveSpan.Continuation.activate() at the appropriate time.
  - context
```
public SpanContext context()
```
    Description copied from interface: BaseSpan
    
    Retrieve the associated SpanContext. This may be called at any time, including after calls to finish().
    
    Specified by:
    
    context in interface BaseSpan<ActiveSpan>
    
    Returns:
    
    the SpanContext that encapsulates Span state that should propagate across process boundaries.
  - setTag
```
public ActiveSpanShim setTag(String key,
                             String value)
```
    Description copied from interface: BaseSpan
    
    Set a key:value tag on the Span.
    
    Specified by:
    
    setTag in interface BaseSpan<ActiveSpan>
  - setTag
```
public ActiveSpanShim setTag(String key,
                             boolean value)
```
    Description copied from interface: BaseSpan
    
    Same as BaseSpan.setTag(String, String), but for boolean values.
    
    Specified by:
    
    setTag in interface BaseSpan<ActiveSpan>
  - setTag
```
public ActiveSpanShim setTag(String key,
                             Number value)
```
    Description copied from interface: BaseSpan
    
    Same as BaseSpan.setTag(String, String), but for numeric values.
    
    Specified by:
    
    setTag in interface BaseSpan<ActiveSpan>
  - log
```
public final ActiveSpanShim log(Map<String,?> fields)
```
    Description copied from interface: BaseSpan
    Log key:value pairs to the Span with the current walltime timestamp.
    CAUTIONARY NOTE: not all Tracer implementations support key:value log fields end-to-end. Caveat emptor.
    A contrived example (using Guava, which is not required):
```
     span.log(
     ImmutableMap.Builder()
     .put("event", "soft error")
     .put("type", "cache timeout")
     .put("waited.millis", 1500)
     .build());
     
```
    Specified by:
    
    log in interface BaseSpan<ActiveSpan>
    
    Parameters:
    
    fields - key:value log fields. Tracer implementations should support String, numeric, and boolean values; some may also support arbitrary Objects.
    
    Returns:
    
    the Span, for chaining
    
    See Also:
    
    BaseSpan.log(String)
  - log
```
public final ActiveSpanShim log(long timestampMicros,
                                Map<String,?> fields)
```
    Description copied from interface: BaseSpan
    
    Like log(Map<String, Object>), but with an explicit timestamp.
    CAUTIONARY NOTE: not all Tracer implementations support key:value log fields end-to-end. Caveat emptor.
    
    Specified by:
    
    log in interface BaseSpan<ActiveSpan>
    
    Parameters:
    
    timestampMicros - The explicit timestamp for the log record. Must be greater than or equal to the Span's start timestamp.
    
    fields - key:value log fields. Tracer implementations should support String, numeric, and boolean values; some may also support arbitrary Objects.
    
    Returns:
    
    the Span, for chaining
    
    See Also:
    
    BaseSpan.log(long, String)
  - log
```
public ActiveSpanShim log(String event)
```
    Description copied from interface: BaseSpan
    Record an event at the current walltime timestamp. Shorthand for
```
     span.log(Collections.singletonMap("event", event));
     
```
    Specified by:
    
    log in interface BaseSpan<ActiveSpan>
    
    Parameters:
    
    event - the event value; often a stable identifier for a moment in the Span lifecycle
    
    Returns:
    
    the Span, for chaining
  - log
```
public ActiveSpanShim log(long timestampMicroseconds,
                          String event)
```
    Description copied from interface: BaseSpan
    Record an event at a specific timestamp. Shorthand for
```
     span.log(timestampMicroseconds, Collections.singletonMap("event", event));
     
```
    Specified by:
    
    log in interface BaseSpan<ActiveSpan>
    
    Parameters:
    
    timestampMicroseconds - The explicit timestamp for the log record. Must be greater than or equal to the Span's start timestamp.
    
    event - the event value; often a stable identifier for a moment in the Span lifecycle
    
    Returns:
    
    the Span, for chaining
  - setBaggageItem
```
public ActiveSpanShim setBaggageItem(String key,
                                     String value)
```
    Description copied from interface: BaseSpan
    
    Sets a baggage item in the Span (and its SpanContext) as a key/value pair. Baggage enables powerful distributed context propagation functionality where arbitrary application data can be carried along the full path of request execution throughout the system. Note 1: Baggage is only propagated to the future (recursive) children of this SpanContext. Note 2: Baggage is sent in-band with every subsequent local and remote calls, so this feature must be used with care.
    
    Specified by:
    
    setBaggageItem in interface BaseSpan<ActiveSpan>
    
    Returns:
    
    this Span instance, for chaining
  - getBaggageItem
```
public String getBaggageItem(String key)
```
    Specified by:
    
    getBaggageItem in interface BaseSpan<ActiveSpan>
    
    Returns:
    
    the value of the baggage item identified by the given key, or null if no such item could be found
  - setOperationName
```
public ActiveSpanShim setOperationName(String operationName)
```
    Description copied from interface: BaseSpan
    
    Sets the string name for the logical operation this span represents.
    
    Specified by:
    
    setOperationName in interface BaseSpan<ActiveSpan>
    
    Returns:
    
    this Span instance, for chaining
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ActiveSpanShim

Nested Class Summary

Nested classes/interfaces inherited from interface io.opentracing.v_030.ActiveSpan

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActiveSpanShim

Method Detail

scope

span

deactivate

close

capture

context

setTag

setTag

setTag

log

log

log

log

setBaggageItem

getBaggageItem

setOperationName

equals

toString