io.opentracing.v_030.shim

Class SpanShim

java.lang.Object

io.opentracing.v_030.shim.SpanShim

All Implemented Interfaces:

BaseSpan<Span>, SpanWrapper, Span

public class SpanShim
extends Object
implements Span, SpanWrapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpanShim(io.opentracing.Span span)

Method Summary

Modifier and Type	Method and Description
SpanContext	context() Retrieve the associated SpanContext.
boolean	equals(Object obj)
void	finish() Sets the end timestamp to now and records the span.
void	finish(long finishMicros) Sets an explicit end timestamp and records the span.
String	getBaggageItem(String key)
SpanShim	log(long timestampMicros, Map<String,?> fields) Like log(Map<String, Object>), but with an explicit timestamp.
SpanShim	log(long timestampMicroseconds, String event) Record an event at a specific timestamp.
SpanShim	log(Map<String,?> fields) Log key:value pairs to the Span with the current walltime timestamp.
SpanShim	log(String event) Record an event at the current walltime timestamp.
SpanShim	setBaggageItem(String key, String value) Sets a baggage item in the Span (and its SpanContext) as a key/value pair.
SpanShim	setOperationName(String operationName) Sets the string name for the logical operation this span represents.
SpanShim	setTag(String key, boolean value) Same as BaseSpan.setTag(String, String), but for boolean values.
SpanShim	setTag(String key, Number value) Same as BaseSpan.setTag(String, String), but for numeric values.
SpanShim	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

SpanShim

protected SpanShim(io.opentracing.Span span)

Method Detail

span

public io.opentracing.Span span()

Specified by:

span in interface SpanWrapper

finish

public void finish()

Description copied from interface: Span

Sets the end timestamp to now and records the span.

With the exception of calls to BaseSpan.context(), this should be the last call made to the span instance. Future calls to Span.finish() are defined as noops, and future calls to methods other than BaseSpan.context() lead to undefined behavior.

Specified by:

finish in interface Span

See Also:

BaseSpan.context()

finish

public void finish(long finishMicros)

Description copied from interface: Span

Sets an explicit end timestamp and records the span.

With the exception of calls to Span.context(), this should be the last call made to the span instance, and to do otherwise leads to undefined behavior.

Specified by:

finish in interface Span

Parameters:

finishMicros - an explicit finish time, in microseconds since the epoch

See Also:

BaseSpan.context()

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<Span>

Returns:

the SpanContext that encapsulates Span state that should propagate across process boundaries.

setTag

public SpanShim setTag(String key,
                       String value)

Description copied from interface: BaseSpan

Set a key:value tag on the Span.

Specified by:

setTag in interface BaseSpan<Span>

setTag

public SpanShim 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<Span>

setTag

public SpanShim 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<Span>

log

public final SpanShim 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<Span>

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 SpanShim 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<Span>

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 SpanShim 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<Span>

Parameters:

event - the event value; often a stable identifier for a moment in the Span lifecycle

Returns:

the Span, for chaining

log

public SpanShim 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<Span>

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 SpanShim 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<Span>

Returns:

this Span instance, for chaining

getBaggageItem

public String getBaggageItem(String key)

Specified by:

getBaggageItem in interface BaseSpan<Span>

Returns:

the value of the baggage item identified by the given key, or null if no such item could be found

setOperationName

public SpanShim 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<Span>

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