Package com.linecorp.armeria.common.brave

Class RequestContextCurrentTraceContext

java.lang.Object

brave.propagation.CurrentTraceContext

com.linecorp.armeria.common.brave.RequestContextCurrentTraceContext

public final class RequestContextCurrentTraceContext
extends CurrentTraceContext

Tracing context implemented with RequestContext.

This CurrentTraceContext stores/loads the trace context into/from a RequestContext's attribute so that there's no need for thread local variables which can lead to unpredictable behavior in asynchronous programming.

Nested Class Summary

Nested classes/interfaces inherited from class brave.propagation.CurrentTraceContext

CurrentTraceContext.Builder, CurrentTraceContext.Default, CurrentTraceContext.Scope, CurrentTraceContext.ScopeDecorator

Method Summary

Modifier and Type	Method	Description
static RequestContextCurrentTraceContextBuilder	builder()	Use this when you need customizations such as log integration via CurrentTraceContext.Builder.addScopeDecorator(ScopeDecorator).
TraceContext	get()
CurrentTraceContext.Scope	newScope(TraceContext currentSpan)
static RequestContextCurrentTraceContext	ofDefault()	Returns the default CurrentTraceContext.
static void	setCurrentThreadNotRequestThread(boolean value)	Sets whether the current thread is not a request thread, meaning it is never executed in the scope of a server or client request and will never have a RequestContext available.

Methods inherited from class brave.propagation.CurrentTraceContext

decorateScope, executor, executorService, maybeScope, wrap, wrap

Methods inherited from class java.lang.Object

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

Method Details

ofDefault

public static RequestContextCurrentTraceContext ofDefault()

Returns the default CurrentTraceContext. Use this when building a Tracing instance for use with BraveService or BraveClient.

If you need to customize the context, use builder() instead.

See Also:

Tracing.Builder.currentTraceContext(CurrentTraceContext)

builder

public static RequestContextCurrentTraceContextBuilder builder()

Use this when you need customizations such as log integration via CurrentTraceContext.Builder.addScopeDecorator(ScopeDecorator).

See Also:

Tracing.Builder.currentTraceContext(CurrentTraceContext)

setCurrentThreadNotRequestThread

public static void setCurrentThreadNotRequestThread(boolean value)

Sets whether the current thread is not a request thread, meaning it is never executed in the scope of a server or client request and will never have a RequestContext available. This can be called from background threads, such as the thread that reports traced spans to storage, to prevent logging a warning when trying to start a trace without having a RequestContext.

For example, you could prevent warnings from the administrative threads controlled by a ThreadFactory like the following:

 > ThreadFactory factory = (runnable) -> new Thread(new Runnable() {
 >     @Override
 >     public void run() {
 >         RequestContextCurrentTraceContext.setCurrentThreadNotRequestThread(true);
 >         runnable.run();
 >     }
 >
 >     @Override
 >     public String toString() {
 >         return runnable.toString();
 >     }
 > });
 

get

@Nullable public TraceContext get()

Specified by:

get in class CurrentTraceContext

newScope

public CurrentTraceContext.Scope newScope(@Nullable TraceContext currentSpan)

Specified by:

newScope in class CurrentTraceContext