io.opentracing.mock

Class MockSpan

java.lang.Object

io.opentracing.mock.MockSpan

All Implemented Interfaces:

Span, Closeable, AutoCloseable

public final class MockSpan
extends Object
implements Span

MockSpans are created via MockTracer.buildSpan(...), but they are also returned via calls to MockTracer.finishedSpans(). They provide accessors to all Span state.

See Also:

MockTracer.finishedSpans()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MockSpan.LogEntry
static class	MockSpan.MockContext MockContext implements a Dapper-like opentracing.SpanContext with a trace- and span-id.

Method Summary

Modifier and Type	Method and Description
void	close()
MockSpan.MockContext	context()
void	finish()
void	finish(long finishMicros)
long	finishMicros()
List<RuntimeException>	generatedErrors()
String	getBaggageItem(String key)
Span	log(long timestampMicros, Map<String,?> fields)
Span	log(long timestampMicroseconds, String event)
Span	log(long timestampMicroseconds, String eventName, Object payload)
Span	log(Map<String,?> fields)
Span	log(String event)
Span	log(String eventName, Object payload)
List<MockSpan.LogEntry>	logEntries()
String	operationName()
long	parentId() TODO: Support multiple parents in this API.
Span	setBaggageItem(String key, String value)
Span	setOperationName(String operationName)
Span	setTag(String key, boolean value)
Span	setTag(String key, Number value)
Span	setTag(String key, String value)
long	startMicros()
Map<String,Object>	tags()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

operationName

public String operationName()

setOperationName

public Span setOperationName(String operationName)

Specified by:

setOperationName in interface Span

parentId

public long parentId()

TODO: Support multiple parents in this API.

Returns:

the spanId of the Span's parent context, or 0 if no such parent exists.

See Also:

MockSpan.MockContext.spanId()

startMicros

public long startMicros()

finishMicros

public long finishMicros()

Returns:

the finish time of the Span; only valid after a call to finish().

tags

public Map<String,Object> tags()

Returns:

a copy of all tags set on this Span.

logEntries

public List<MockSpan.LogEntry> logEntries()

Returns:

a copy of all log entries added to this Span.

generatedErrors

public List<RuntimeException> generatedErrors()

Returns:

a copy of exceptions thrown by this class (e.g. adding a tag after span is finished).

context

public MockSpan.MockContext context()

Specified by:

context in interface Span

finish

public void finish()

Specified by:

finish in interface Span

finish

public void finish(long finishMicros)

Specified by:

finish in interface Span

close

public void close()

Specified by:

close in interface Span

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

setTag

public Span setTag(String key,
                   String value)

Specified by:

setTag in interface Span

setTag

public Span setTag(String key,
                   boolean value)

Specified by:

setTag in interface Span

setTag

public Span setTag(String key,
                   Number value)

Specified by:

setTag in interface Span

log

public final Span log(Map<String,?> fields)

Specified by:

log in interface Span

log

public final Span log(long timestampMicros,
                      Map<String,?> fields)

Specified by:

log in interface Span

log

public Span log(String event)

Specified by:

log in interface Span

log

public Span log(long timestampMicroseconds,
                String event)

Specified by:

log in interface Span

log

public Span log(String eventName,
                Object payload)

Specified by:

log in interface Span

log

public Span log(long timestampMicroseconds,
                String eventName,
                Object payload)

Specified by:

log in interface Span

setBaggageItem

public Span setBaggageItem(String key,
                           String value)

Specified by:

setBaggageItem in interface Span

getBaggageItem

public String getBaggageItem(String key)

Specified by:

getBaggageItem in interface Span

toString

public String toString()

Overrides:

toString in class Object