io.opentracing.mock

Class MockTracer

java.lang.Object

io.opentracing.mock.MockTracer

All Implemented Interfaces:

Tracer, Closeable, AutoCloseable

public class MockTracer
extends Object
implements Tracer

MockTracer makes it easy to test the semantics of OpenTracing instrumentation. By using a MockTracer as an io.opentracing.Tracer implementation for unittests, a developer can assert that Span properties and relationships with other Spans are defined as expected by instrumentation code. The MockTracerTest has simple usage examples.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MockTracer.Propagator Propagator allows the developer to intercept and verify any calls to inject() and/or extract().
class	MockTracer.SpanBuilder

Constructor Summary

Constructors

Constructor and Description
MockTracer()
MockTracer(MockTracer.Propagator propagator) Create a new MockTracer that passes through any calls to inject() and/or extract().
MockTracer(ScopeManager scopeManager)
MockTracer(ScopeManager scopeManager, MockTracer.Propagator propagator)

Method Summary

Modifier and Type	Method and Description
Scope	activateSpan(Span span)
Span	activeSpan()
MockTracer.SpanBuilder	buildSpan(String operationName)
void	close()
<C> SpanContext	extract(Format<C> format, C carrier)
List<MockSpan>	finishedSpans()
<C> void	inject(SpanContext spanContext, Format<C> format, C carrier)
protected void	onSpanFinished(MockSpan mockSpan) Noop method called on Span.finish().
void	reset() Clear the finishedSpans() queue.
ScopeManager	scopeManager()

Methods inherited from class java.lang.Object

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

Constructor Detail

MockTracer

public MockTracer()

MockTracer

public MockTracer(ScopeManager scopeManager)

MockTracer

public MockTracer(ScopeManager scopeManager,
                  MockTracer.Propagator propagator)

MockTracer

public MockTracer(MockTracer.Propagator propagator)

Create a new MockTracer that passes through any calls to inject() and/or extract().

Method Detail

reset

public void reset()

Clear the finishedSpans() queue. Note that this does *not* have any effect on Spans created by MockTracer that have not finish()ed yet; those will still be enqueued in finishedSpans() when they finish().

finishedSpans

public List<MockSpan> finishedSpans()

Returns:

a copy of all finish()ed MockSpans started by this MockTracer (since construction or the last call to MockTracer.reset()).

See Also:

reset()

onSpanFinished

protected void onSpanFinished(MockSpan mockSpan)

Noop method called on Span.finish().

scopeManager

public ScopeManager scopeManager()

Specified by:

scopeManager in interface Tracer

buildSpan

public MockTracer.SpanBuilder buildSpan(String operationName)

Specified by:

buildSpan in interface Tracer

inject

public <C> void inject(SpanContext spanContext,
                       Format<C> format,
                       C carrier)

Specified by:

inject in interface Tracer

extract

public <C> SpanContext extract(Format<C> format,
                               C carrier)

Specified by:

extract in interface Tracer

activeSpan

public Span activeSpan()

Specified by:

activeSpan in interface Tracer

activateSpan

public Scope activateSpan(Span span)

Specified by:

activateSpan in interface Tracer

close

public void close()

Specified by:

close in interface Tracer

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable