datadog.trace.context

Interface TraceScope

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

NoopTraceScope

public interface TraceScope
extends Closeable

An object which can propagate a datadog trace across multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TraceScope.Continuation Used to pass async context between workers.

Method Summary

Modifier and Type	Method and Description
TraceScope.Continuation	capture() Prevent the trace attached to this TraceScope from reporting until the returned Continuation is either activated (and the returned scope is closed), or canceled.
TraceScope.Continuation	captureConcurrent() Prevent the trace attached to this TraceScope from reporting until the returned Continuation is either activated (and the returned scope is closed), or canceled.
void	close() Close the activated context and allow any underlying spans to finish.
default boolean	isAsyncPropagating() Deprecated. Replaced by Tracer.isAsyncPropagationEnabled(). Calling this method will check whether asynchronous propagation is active for the active scope, not this scope instance.
default void	setAsyncPropagation(boolean value) Deprecated. Replaced by Tracer.setAsyncPropagationEnabled(boolean)}. Calling this method will enable or disable asynchronous propagation for the active scope, not this scope instance.

Method Detail

capture

TraceScope.Continuation capture()

Prevent the trace attached to this TraceScope from reporting until the returned Continuation is either activated (and the returned scope is closed), or canceled.

Should be called on the parent thread.

captureConcurrent

TraceScope.Continuation captureConcurrent()

Prevent the trace attached to this TraceScope from reporting until the returned Continuation is either activated (and the returned scope is closed), or canceled.

Should be called on the parent thread.

If the returned TraceScope.Continuation is activated, it needs to be canceled in addition to the returned TraceScope being closed. This is to allow multiple concurrent threads that activate the continuation to race in a safe way, and close the scopes without fear of closing the related Span prematurely.

close

void close()

Close the activated context and allow any underlying spans to finish.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isAsyncPropagating

@Deprecated
default boolean isAsyncPropagating()

Deprecated. Replaced by Tracer.isAsyncPropagationEnabled().

Calling this method will check whether asynchronous propagation is active for the active scope, not this scope instance.

Returns:

true if asynchronous propagation is enabled for the active scope, false otherwise.

setAsyncPropagation

@Deprecated
default void setAsyncPropagation(boolean value)

Deprecated. Replaced by Tracer.setAsyncPropagationEnabled(boolean)}.

Calling this method will enable or disable asynchronous propagation for the active scope, not this scope instance.

Parameters:

value - @true to enable asynchronous propagation, false to disable it.