io.opentracing.v_030.mock

Class MockTracer.SpanBuilder

java.lang.Object

io.opentracing.v_030.mock.MockTracer.SpanBuilder

All Implemented Interfaces:

Tracer.SpanBuilder

Enclosing class:

MockTracer

public final class MockTracer.SpanBuilder
extends Object
implements Tracer.SpanBuilder

Method Summary

Modifier and Type	Method and Description
MockTracer.SpanBuilder	addReference(String referenceType, SpanContext referencedContext) Add a reference from the Span being built to a distinct (usually parent) Span.
MockTracer.SpanBuilder	asChildOf(BaseSpan parent) A shorthand for addReference(References.CHILD_OF, parent.context()).
MockTracer.SpanBuilder	asChildOf(SpanContext parent) A shorthand for addReference(References.CHILD_OF, parent).
MockTracer.SpanBuilder	ignoreActiveSpan() Do not create an implicit References.CHILD_OF reference to the ActiveSpanSource.activeSpan()).
MockSpan	start()
ActiveSpan	startActive() Returns a newly started and activated ActiveSpan.
MockSpan	startManual() Like Tracer.SpanBuilder.startActive(), but the returned Span has not been registered via the ActiveSpanSource.
MockTracer.SpanBuilder	withStartTimestamp(long microseconds) Specify a timestamp of when the Span was started, represented in microseconds since epoch.
MockTracer.SpanBuilder	withTag(String key, boolean value) Same as BaseSpan.setTag(String, boolean), but for the span being built.
MockTracer.SpanBuilder	withTag(String key, Number value) Same as BaseSpan.setTag(String, Number), but for the span being built.
MockTracer.SpanBuilder	withTag(String key, String value) Same as BaseSpan.setTag(String, String), but for the span being built.

Methods inherited from class java.lang.Object

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

Method Detail

asChildOf

public MockTracer.SpanBuilder asChildOf(SpanContext parent)

Description copied from interface: Tracer.SpanBuilder

A shorthand for addReference(References.CHILD_OF, parent).

If parent==null, this is a noop.

Specified by:

asChildOf in interface Tracer.SpanBuilder

asChildOf

public MockTracer.SpanBuilder asChildOf(BaseSpan parent)

Description copied from interface: Tracer.SpanBuilder

A shorthand for addReference(References.CHILD_OF, parent.context()).

If parent==null, this is a noop.

Specified by:

asChildOf in interface Tracer.SpanBuilder

ignoreActiveSpan

public MockTracer.SpanBuilder ignoreActiveSpan()

Description copied from interface: Tracer.SpanBuilder

Do not create an implicit References.CHILD_OF reference to the ActiveSpanSource.activeSpan()).

Specified by:

ignoreActiveSpan in interface Tracer.SpanBuilder

addReference

public MockTracer.SpanBuilder addReference(String referenceType,
                                           SpanContext referencedContext)

Description copied from interface: Tracer.SpanBuilder

Add a reference from the Span being built to a distinct (usually parent) Span. May be called multiple times to represent multiple such References.

If

• the Tracer's ActiveSpanSource.activeSpan() is not null, and
• no explicit references are added via Tracer.SpanBuilder.addReference(java.lang.String, io.opentracing.v_030.SpanContext), and
• Tracer.SpanBuilder.ignoreActiveSpan() is not invoked,

... then an inferred References.CHILD_OF reference is created to the ActiveSpanSource.activeSpan() SpanContext when either Tracer.SpanBuilder.startActive() or Tracer.SpanBuilder.startManual() is invoked.

Specified by:

addReference in interface Tracer.SpanBuilder

Parameters:

referenceType - the reference type, typically one of the constants defined in References

referencedContext - the SpanContext being referenced; e.g., for a References.CHILD_OF referenceType, the referencedContext is the parent. If referencedContext==null, the call to Tracer.SpanBuilder.addReference(java.lang.String, io.opentracing.v_030.SpanContext) is a noop.

See Also:

References

withTag

public MockTracer.SpanBuilder withTag(String key,
                                      String value)

Description copied from interface: Tracer.SpanBuilder

Same as BaseSpan.setTag(String, String), but for the span being built.

Specified by:

withTag in interface Tracer.SpanBuilder

withTag

public MockTracer.SpanBuilder withTag(String key,
                                      boolean value)

Description copied from interface: Tracer.SpanBuilder

Same as BaseSpan.setTag(String, boolean), but for the span being built.

Specified by:

withTag in interface Tracer.SpanBuilder

withTag

public MockTracer.SpanBuilder withTag(String key,
                                      Number value)

Description copied from interface: Tracer.SpanBuilder

Same as BaseSpan.setTag(String, Number), but for the span being built.

Specified by:

withTag in interface Tracer.SpanBuilder

withStartTimestamp

public MockTracer.SpanBuilder withStartTimestamp(long microseconds)

Description copied from interface: Tracer.SpanBuilder

Specify a timestamp of when the Span was started, represented in microseconds since epoch.

Specified by:

withStartTimestamp in interface Tracer.SpanBuilder

start

public MockSpan start()

Specified by:

start in interface Tracer.SpanBuilder

startActive

public ActiveSpan startActive()

Description copied from interface: Tracer.SpanBuilder

Returns a newly started and activated ActiveSpan.

The returned ActiveSpan supports try-with-resources. For example:

     try (ActiveSpan span = tracer.buildSpan("...").startActive()) {
         // (Do work)
         span.setTag( ... );  // etc, etc
     }  // Span finishes automatically unless deferred via ActiveSpan.capture()
 

If

• the Tracer's ActiveSpanSource.activeSpan() is not null, and
• no explicit references are added via Tracer.SpanBuilder.addReference(java.lang.String, io.opentracing.v_030.SpanContext), and
• Tracer.SpanBuilder.ignoreActiveSpan() is not invoked,

... then an inferred References.CHILD_OF reference is created to the ActiveSpanSource.activeSpan()'s SpanContext when either Tracer.SpanBuilder.startManual() or Tracer.SpanBuilder.startActive() is invoked.

Note: Tracer.SpanBuilder.startActive() is a shorthand for tracer.makeActive(spanBuilder.startManual()).

Specified by:

startActive in interface Tracer.SpanBuilder

Returns:

an ActiveSpan, already registered via the ActiveSpanSource

See Also:

ActiveSpanSource, ActiveSpan

startManual

public MockSpan startManual()

Description copied from interface: Tracer.SpanBuilder

Like Tracer.SpanBuilder.startActive(), but the returned Span has not been registered via the ActiveSpanSource.

Specified by:

startManual in interface Tracer.SpanBuilder

Returns:

the newly-started Span instance, which has *not* been automatically registered via the ActiveSpanSource

See Also:

Tracer.SpanBuilder.startActive()