Module brave

Package brave.internal

Class InternalPropagation

java.lang.Object

brave.internal.InternalPropagation

public abstract class InternalPropagation
extends java.lang.Object

Escalate internal APIs in brave.propagation so they can be used from outside packages. The only implementation is in SamplingFlags.

Inspired by okhttp3.internal.Internal.

Field Summary

Fields

Modifier and Type	Field	Description
static int	FLAG_DEBUG
static int	FLAG_LOCAL_ROOT
static int	FLAG_SAMPLED	A flags bitfield is used internally inside TraceContext as opposed to several booleans.
static int	FLAG_SAMPLED_LOCAL
static int	FLAG_SAMPLED_SET
static int	FLAG_SHARED
static InternalPropagation	instance

Constructor Summary

Constructors

Constructor	Description
InternalPropagation()

Method Summary

Modifier and Type	Method	Description
abstract int	flags(SamplingFlags flags)
abstract TraceContext	newTraceContext(int flags, long traceIdHigh, long traceId, long localRootId, long parentId, long spanId, java.util.List<java.lang.Object> extra)
static int	sampled(boolean sampled, int flags)
abstract TraceContext	withExtra(TraceContext context, java.util.List<java.lang.Object> immutableExtra)	TraceContext is immutable so you need to read the result
abstract TraceContext	withFlags(TraceContext context, int flags)	TraceContext is immutable so you need to read the result

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_SAMPLED

public static final int FLAG_SAMPLED

A flags bitfield is used internally inside TraceContext as opposed to several booleans. This reduces the size of the object and allows us to set or check a couple states at once.

See Also:

Constant Field Values

FLAG_SAMPLED_SET

public static final int FLAG_SAMPLED_SET

See Also:

Constant Field Values

FLAG_DEBUG

public static final int FLAG_DEBUG

See Also:

Constant Field Values

FLAG_SHARED

public static final int FLAG_SHARED

See Also:

Constant Field Values

FLAG_SAMPLED_LOCAL

public static final int FLAG_SAMPLED_LOCAL

See Also:

Constant Field Values

FLAG_LOCAL_ROOT

public static final int FLAG_LOCAL_ROOT

See Also:

Constant Field Values

instance

public static InternalPropagation instance

Constructor Detail

InternalPropagation

public InternalPropagation()

Method Detail

flags

public abstract int flags(SamplingFlags flags)

sampled

public static int sampled(boolean sampled,
                          int flags)

newTraceContext

public abstract TraceContext newTraceContext(int flags,
                                             long traceIdHigh,
                                             long traceId,
                                             long localRootId,
                                             long parentId,
                                             long spanId,
                                             java.util.List<java.lang.Object> extra)

Parameters:

localRootId - must be non-zero prior to instantiating Span or ScopedSpan

withExtra

public abstract TraceContext withExtra(TraceContext context,
                                       java.util.List<java.lang.Object> immutableExtra)

TraceContext is immutable so you need to read the result

withFlags

public abstract TraceContext withFlags(TraceContext context,
                                       int flags)

TraceContext is immutable so you need to read the result