com.github.kristofa.brave

Class SpanId

java.lang.Object

com.github.kristofa.brave.SpanId

public final class SpanId
extends Object

Contains trace data that's propagated in-band across requests, sometimes known as Baggage.

This implementation is biased towards a fixed-length binary serialization format that doesn't have a way to represent an absent parent (root span). In this serialized form, a root span is when all three ids are the same. Alternatively, you can use nullableParentId().

Particularly, this includes sampled state, and a portable binary representation. The implementation is a port of com.twitter.finagle.tracing.TraceId.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpanId.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_DEBUG
static int	FLAG_IS_ROOT When set, we can ignore the value of the parentId
static int	FLAG_SAMPLED
static int	FLAG_SAMPLING_SET When set, we can interpret FLAG_SAMPLED as a set value.
long	flags Raw flags encoded in bytes()
long	parentId The parent's spanId or spanId if this the root span in a trace.
long	spanId Unique 8-byte identifier of this span within a trace.
long	traceId Unique 8-byte identifier for a trace, set on all spans within it.

Constructor Summary

Constructors

Constructor and Description
SpanId(long traceId, long parentId, long spanId, long flags) Deprecated. Please use SpanId.Builder

Method Summary

Modifier and Type	Method and Description
static SpanId.Builder	builder()
byte[]	bytes() Serializes this into a big-endian byte array
static SpanId	create(long traceId, long spanId, Long parentSpanId) Deprecated. Please use SpanId.Builder
boolean	debug() True is a request to store this span even if it overrides sampling policy.
boolean	equals(Object o)
static SpanId	fromBytes(byte[] bytes) Deserializes this from a big-endian byte array
Long	getParentSpanId() Deprecated. use nullableParentId()
long	getSpanId() Deprecated. use spanId
long	getTraceId() Deprecated. use traceId
int	hashCode()
Long	nullableParentId() Returns null when this is a root span.
boolean	root() Returns true if this is the root span.
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.
SpanId.Builder	toBuilder()
Span	toSpan() Preferred way to create spans, as it properly deals with the parent id
String	toString() Returns $traceId.$spanId<:$parentId

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_DEBUG

public static final int FLAG_DEBUG

See Also:

Constant Field Values

FLAG_SAMPLING_SET

public static final int FLAG_SAMPLING_SET

When set, we can interpret FLAG_SAMPLED as a set value.

See Also:

Constant Field Values

FLAG_SAMPLED

public static final int FLAG_SAMPLED

See Also:

Constant Field Values

FLAG_IS_ROOT

public static final int FLAG_IS_ROOT

When set, we can ignore the value of the parentId

While many zipkin systems re-use a trace id as the root span id, we know that some don't. With this flag, we can tell for sure if the span is root as opposed to the convention trace id == span id == parent id.

See Also:

Constant Field Values

traceId

public final long traceId

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

parentId

public final long parentId

The parent's spanId or spanId if this the root span in a trace.

spanId

public final long spanId

Unique 8-byte identifier of this span within a trace.

A span is uniquely identified in storage by (traceId, #id).

flags

public final long flags

Raw flags encoded in bytes()

Constructor Detail

SpanId

@Deprecated
public SpanId(long traceId,
                          long parentId,
                          long spanId,
                          long flags)

Deprecated. Please use SpanId.Builder

Method Detail

create

@Deprecated
public static SpanId create(long traceId,
                                        long spanId,
                                        @Nullable
                                        Long parentSpanId)

Deprecated. Please use SpanId.Builder

Creates a new span id.

Parameters:

traceId - Trace Id.

spanId - Span Id.

parentSpanId - Nullable parent span id.

fromBytes

public static SpanId fromBytes(byte[] bytes)

Deserializes this from a big-endian byte array

builder

public static SpanId.Builder builder()

getTraceId

@Deprecated
public long getTraceId()

Deprecated. use traceId

Get Trace id.

Returns:

Trace id.

getSpanId

@Deprecated
public long getSpanId()

Deprecated. use spanId

Get span id.

Returns:

span id.

getParentSpanId

@Deprecated
 @Nullable
public Long getParentSpanId()

Deprecated. use nullableParentId()

Get parent span id.

Returns:

Parent span id. Can be null.

nullableParentId

@Nullable
public Long nullableParentId()

Returns null when this is a root span.

root

public final boolean root()

Returns true if this is the root span.

debug

public final boolean debug()

True is a request to store this span even if it overrides sampling policy. Implies sampled().

sampled

@Nullable
public final 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.

bytes

public byte[] bytes()

Serializes this into a big-endian byte array

toBuilder

public SpanId.Builder toBuilder()

toString

public String toString()

Returns $traceId.$spanId<:$parentId

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toSpan

public Span toSpan()

Preferred way to create spans, as it properly deals with the parent id