Package com.github.kristofa.brave

Class SpanId

java.lang.Object

com.github.kristofa.brave.SpanId

Deprecated.

Replaced by brave.propagation.TraceContext

@Deprecated
public final class SpanId
extends java.lang.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	Description
static class	SpanId.Builder	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
static int	FLAG_DEBUG	Deprecated.
static int	FLAG_IS_ROOT	Deprecated. When set, we can ignore the value of the parentId
static int	FLAG_SAMPLED	Deprecated.
static int	FLAG_SAMPLING_SET	Deprecated. When set, we can interpret FLAG_SAMPLED as a set value.
long	flags	Deprecated. Raw flags encoded in bytes()
long	parentId	Deprecated. The parent's spanId or spanId if this the root span in a trace.
boolean	shared	Deprecated. it is unnecessary overhead to propagate this property
long	spanId	Deprecated. Unique 8-byte identifier of this span within a trace.
long	traceId	Deprecated. Unique 8-byte identifier for a trace, set on all spans within it.
long	traceIdHigh	Deprecated. When non-zero, the trace containing this span uses 128-bit trace identifiers.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SpanId.Builder	builder()	Deprecated.
byte[]	bytes()	Deprecated. Serializes this into a big-endian byte array
static SpanId	create(long traceId, long spanId, java.lang.Long parentSpanId)	Deprecated. Please use SpanId.Builder
boolean	debug()	Deprecated. True is a request to store this span even if it overrides sampling policy.
boolean	equals(java.lang.Object o)	Deprecated.
static SpanId	fromBytes(byte[] bytes)	Deprecated. Deserializes this from a big-endian byte array
java.lang.Long	getParentSpanId()	Deprecated. use nullableParentId()
long	getSpanId()	Deprecated. use spanId
long	getTraceId()	Deprecated. use traceId
int	hashCode()	Deprecated.
java.lang.Long	nullableParentId()	Deprecated. Returns null when this is a root span.
boolean	root()	Deprecated. Returns true if this is the root span.
java.lang.Boolean	sampled()	Deprecated. 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()	Deprecated.
java.lang.String	toString()	Deprecated. Returns $traceId.$spanId<:$parentId
java.lang.String	traceIdString()	Deprecated. Returns the hex representation of the span's trace ID

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

Deprecated.

See Also:

Constant Field Values

FLAG_SAMPLING_SET

public static final int FLAG_SAMPLING_SET

Deprecated.

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

See Also:

Constant Field Values

FLAG_SAMPLED

public static final int FLAG_SAMPLED

Deprecated.

See Also:

Constant Field Values

FLAG_IS_ROOT

public static final int FLAG_IS_ROOT

Deprecated.

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

traceIdHigh

public final long traceIdHigh

Deprecated.

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

Since:

3.15

traceId

public final long traceId

Deprecated.

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

parentId

public final long parentId

Deprecated.

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

spanId

public final long spanId

Deprecated.

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

Deprecated.

Raw flags encoded in bytes()

shared

@Deprecated
public final boolean shared

Deprecated. it is unnecessary overhead to propagate this property

See Also:

Constant Field Values

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
                            java.lang.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)

Deprecated.

Deserializes this from a big-endian byte array

builder

public static SpanId.Builder builder()

Deprecated.

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 java.lang.Long getParentSpanId()

Deprecated. use nullableParentId()

Get parent span id.

Returns:

Parent span id. Can be null.

nullableParentId

@Nullable
public java.lang.Long nullableParentId()

Deprecated.

Returns null when this is a root span.

root

public final boolean root()

Deprecated.

Returns true if this is the root span.

debug

public final boolean debug()

Deprecated.

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

sampled

@Nullable
public final java.lang.Boolean sampled()

Deprecated.

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()

Deprecated.

Serializes this into a big-endian byte array

toBuilder

public SpanId.Builder toBuilder()

Deprecated.

toString

public java.lang.String toString()

Deprecated.

Returns $traceId.$spanId<:$parentId

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Deprecated.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class java.lang.Object

traceIdString

public java.lang.String traceIdString()

Deprecated.

Returns the hex representation of the span's trace ID

Since:

3.15