Module brave

Package brave.propagation

Class TraceContextOrSamplingFlags

java.lang.Object

brave.propagation.TraceContextOrSamplingFlags

public final class TraceContextOrSamplingFlags
extends java.lang.Object

Union type that contains only one of trace context, trace ID context or sampling flags. This type is designed for use with Tracer.nextSpan(TraceContextOrSamplingFlags).

Users should not create instances of this, rather use TraceContext.Extractor provided by a Propagation implementation such as Propagation.B3_STRING.

Those implementing Propagation should use the following advice:

   
If you have the trace and span ID, use create(TraceContext)
   
If you have only a trace ID, use create(TraceIdContext)
   
Otherwise, use create(SamplingFlags)
 

If your propagation implementation adds extra data, append it via TraceContextOrSamplingFlags.Builder.addExtra(Object).

This started as a port of com.github.kristofa.brave.TraceData, which served the same purpose.

See Also:

TraceContext.Extractor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TraceContextOrSamplingFlags.Builder

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
TraceContext	context()
static TraceContextOrSamplingFlags	create(SamplingFlags flags)
static TraceContextOrSamplingFlags	create(TraceContext context)
static TraceContextOrSamplingFlags	create(TraceIdContext traceIdContext)
static TraceContextOrSamplingFlags	create(java.lang.Boolean sampled, boolean debug)
boolean	equals(java.lang.Object o)
java.util.List<java.lang.Object>	extra()	Non-empty when context() is null: A list of additional data extracted from the carrier.
int	hashCode()
static TraceContextOrSamplingFlags.Builder	newBuilder()
java.lang.Boolean	sampled()	Returns SamplingFlags.sampled(), regardless of subtype.
TraceContextOrSamplingFlags	sampled(boolean sampled)
TraceContextOrSamplingFlags	sampled(java.lang.Boolean sampled)	Deprecated. do not use object variant..
boolean	sampledLocal()	Returns SamplingFlags.sampledLocal()}, regardless of subtype.
SamplingFlags	samplingFlags()
TraceContextOrSamplingFlags.Builder	toBuilder()
java.lang.String	toString()
TraceIdContext	traceIdContext()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final TraceContextOrSamplingFlags EMPTY

NOT_SAMPLED

public static final TraceContextOrSamplingFlags NOT_SAMPLED

SAMPLED

public static final TraceContextOrSamplingFlags SAMPLED

DEBUG

public static final TraceContextOrSamplingFlags DEBUG

Method Detail

newBuilder

public static TraceContextOrSamplingFlags.Builder newBuilder()

sampled

@Nullable
public java.lang.Boolean sampled()

Returns SamplingFlags.sampled(), regardless of subtype.

sampledLocal

public final boolean sampledLocal()

Returns SamplingFlags.sampledLocal()}, regardless of subtype.

sampled

@Deprecated
public TraceContextOrSamplingFlags sampled(@Nullable
                                           java.lang.Boolean sampled)

Deprecated.

do not use object variant.. only set when you have a sampling decision

sampled

public TraceContextOrSamplingFlags sampled(boolean sampled)

context

@Nullable
public TraceContext context()

traceIdContext

@Nullable
public TraceIdContext traceIdContext()

samplingFlags

@Nullable
public SamplingFlags samplingFlags()

extra

public final java.util.List<java.lang.Object> extra()

Non-empty when context() is null: A list of additional data extracted from the carrier.

See Also:

TraceContext.extra()

toBuilder

public final TraceContextOrSamplingFlags.Builder toBuilder()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

create

public static TraceContextOrSamplingFlags create(TraceContext context)

create

public static TraceContextOrSamplingFlags create(TraceIdContext traceIdContext)

create

public static TraceContextOrSamplingFlags create(SamplingFlags flags)

create

public static TraceContextOrSamplingFlags create(@Nullable
                                                 java.lang.Boolean sampled,
                                                 boolean debug)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object