Package brave.propagation

Class SamplingFlags

java.lang.Object

brave.propagation.SamplingFlags

Direct Known Subclasses:

TraceContext, TraceIdContext

public class SamplingFlags
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SamplingFlags.Builder	Deprecated. prefer using constants. This will be removed in Brave v6

Field Summary

Fields

Modifier and Type	Field	Description
static SamplingFlags	DEBUG
static SamplingFlags	EMPTY
static SamplingFlags	NOT_SAMPLED
static SamplingFlags	SAMPLED

Method Summary

Modifier and Type	Method	Description
SamplingFlags	build()
boolean	debug()	True is a request to store this span even if it overrides sampling policy.
Boolean	sampled()	Sampled means send span data to Zipkin (or something else compatible with its data).
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final SamplingFlags EMPTY

NOT_SAMPLED

public static final SamplingFlags NOT_SAMPLED

SAMPLED

public static final SamplingFlags SAMPLED

DEBUG

public static final SamplingFlags DEBUG

Method Detail

build

public SamplingFlags build()

sampled

@Nullable
public final Boolean sampled()

Sampled means send span data to Zipkin (or something else compatible with its data). It is a consistent decision for an entire request (trace-scoped). For example, the value should not move from true to false, even if the decision itself can be deferred.

Here are the valid options:

   
True means the trace is reported, starting with the first span to set the value true
   
False means the trace should not be reported
   
Null means the decision should be deferred to the next hop
 

Once set to true or false, it is expected that this decision is propagated and honored downstream.

Note: sampling does not imply the trace is invisible to others. For example, a common practice is to generate and propagate identifiers always. This allows other systems, such as logging, to correlate even when the tracing system has no data.

debug

public final boolean debug()

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

toString

public String toString()

Overrides:

toString in class Object