io.opentracing

Interface ScopeManager

public interface ScopeManager

The ScopeManager interface abstracts both the activation of Span instances (via activate(Span)) and access to an active Span/Scope (via active()).

See Also:

Scope, Tracer.scopeManager()

Method Summary

Modifier and Type	Method and Description
Scope	activate(Span span) Make a Span instance active.
Scope	activate(Span span, boolean finishSpanOnClose) Make a Span instance active.
Scope	active() Return the currently active Scope which can be used to access the currently active Scope.span().

Method Detail

activate

Scope activate(Span span)

Make a Span instance active.

Parameters:

span - the Span that should become the active()

Returns:

a Scope instance to control the end of the active period for the Span. Span will automatically be finished when Scope.close() is called. It is a programming error to neglect to call Scope.close() on the returned instance.

activate

Scope activate(Span span,
               boolean finishSpanOnClose)

Make a Span instance active.

Parameters:

span - the Span that should become the active()

finishSpanOnClose - whether span should automatically be finished when Scope.close() is called

Returns:

a Scope instance to control the end of the active period for the Span. It is a programming error to neglect to call Scope.close() on the returned instance.

active

Scope active()

Return the currently active Scope which can be used to access the currently active Scope.span().

If there is an non-null scope, its wrapped Span becomes an implicit parent of any newly-created Span at Tracer.SpanBuilder.startActive() time (rather than at Tracer.buildSpan(String) time).

Returns:

the active scope, or null if none could be found.