Package brave.propagation

Class TraceIdContext

java.lang.Object

brave.propagation.SamplingFlags

brave.propagation.TraceIdContext

public final class TraceIdContext
extends SamplingFlags

Contains inbound trace ID and sampling flags, used when users control the root trace ID, but not the span ID (ex Amazon X-Ray or other correlation).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TraceIdContext.Builder

Field Summary

Fields inherited from class brave.propagation.SamplingFlags

DEBUG, EMPTY, NOT_SAMPLED, SAMPLED

Method Summary

Modifier and Type	Method	Description
boolean	debug()	True is a request to store this span even if it overrides sampling policy.
boolean	equals(Object o)	Only includes mandatory fields traceIdHigh() and traceId()
int	hashCode()	Only includes mandatory fields traceIdHigh() and traceId()
static TraceIdContext.Builder	newBuilder()
Boolean	sampled()	Should we sample this request or not? True means sample, false means don't, null means we defer decision to someone further down in the stack.
TraceIdContext.Builder	toBuilder()
String	toString()	Returns $traceId
long	traceId()	Unique 8-byte identifier for a trace, set on all spans within it.
long	traceIdHigh()	When non-zero, the trace containing this span uses 128-bit trace identifiers.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public static TraceIdContext.Builder newBuilder()

traceIdHigh

public long traceIdHigh()

When non-zero, the trace containing this span uses 128-bit trace identifiers.

traceId

public long traceId()

Unique 8-byte identifier for a trace, set on all spans within it.

sampled

@Nullable
public Boolean sampled()

Should we sample this request or not? True means sample, false means don't, null means we defer decision to someone further down in the stack.

Specified by:

sampled in class SamplingFlags

debug

public boolean debug()

True is a request to store this span even if it overrides sampling policy. Defaults to false.

Specified by:

debug in class SamplingFlags

toBuilder

public TraceIdContext.Builder toBuilder()

toString

public String toString()

Returns $traceId

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Only includes mandatory fields traceIdHigh() and traceId()

Overrides:

equals in class Object

hashCode

public int hashCode()

Only includes mandatory fields traceIdHigh() and traceId()

Overrides:

hashCode in class Object