io.opentelemetry.trace

Class SpanContext

java.lang.Object

io.opentelemetry.trace.SpanContext

@Immutable
public abstract class SpanContext
extends Object

A class that represents a span context. A span context contains the state that must propagate to child Spans and across process boundaries. It contains the identifiers (a trace_id and span_id) associated with the Span and a set of options, as well as the traceState and the remote flag.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
SpanContext()

Method Summary

Modifier and Type	Method and Description
static SpanContext	create(TraceId traceId, SpanId spanId, TraceFlags traceFlags, TraceState traceState) Creates a new SpanContext with the given identifiers and options.
static SpanContext	createFromRemoteParent(TraceId traceId, SpanId spanId, TraceFlags traceFlags, TraceState traceState) Creates a new SpanContext that was propagated from a remote parent, with the given identifiers and options.
static SpanContext	getInvalid() Returns the invalid SpanContext that can be used for no-op operations.
abstract SpanId	getSpanId() Returns the span identifier associated with this SpanContext.
abstract TraceFlags	getTraceFlags() Returns the TraceFlags associated with this SpanContext.
abstract TraceId	getTraceId() Returns the trace identifier associated with this SpanContext.
abstract TraceState	getTraceState() Returns the TraceState associated with this SpanContext.
abstract boolean	isRemote() Returns true if the SpanContext was propagated from a remote parent.
boolean	isValid() Returns true if this SpanContext is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanContext

public SpanContext()

Method Detail

getInvalid

public static SpanContext getInvalid()

Returns the invalid SpanContext that can be used for no-op operations.

Returns:

the invalid SpanContext.

create

public static SpanContext create(TraceId traceId,
                                 SpanId spanId,
                                 TraceFlags traceFlags,
                                 TraceState traceState)

Creates a new SpanContext with the given identifiers and options.

Parameters:

traceId - the trace identifier of the span context.

spanId - the span identifier of the span context.

traceFlags - the trace options for the span context.

traceState - the trace state for the span context.

Returns:

a new SpanContext with the given identifiers and options.

Since:

0.1.0

createFromRemoteParent

public static SpanContext createFromRemoteParent(TraceId traceId,
                                                 SpanId spanId,
                                                 TraceFlags traceFlags,
                                                 TraceState traceState)

Creates a new SpanContext that was propagated from a remote parent, with the given identifiers and options.

Parameters:

traceId - the trace identifier of the span context.

spanId - the span identifier of the span context.

traceFlags - the trace options for the span context.

traceState - the trace state for the span context.

Returns:

a new SpanContext with the given identifiers and options.

Since:

0.1.0

getTraceId

public abstract TraceId getTraceId()

Returns the trace identifier associated with this SpanContext.

Returns:

the trace identifier associated with this SpanContext.

Since:

0.1.0

getSpanId

public abstract SpanId getSpanId()

Returns the span identifier associated with this SpanContext.

Returns:

the span identifier associated with this SpanContext.

Since:

0.1.0

getTraceFlags

public abstract TraceFlags getTraceFlags()

Returns the TraceFlags associated with this SpanContext.

Returns:

the TraceFlags associated with this SpanContext.

Since:

0.1.0

getTraceState

public abstract TraceState getTraceState()

Returns the TraceState associated with this SpanContext.

Returns:

the TraceState associated with this SpanContext.

Since:

0.1.0

isValid

public boolean isValid()

Returns true if this SpanContext is valid.

Returns:

true if this SpanContext is valid.

Since:

0.1.0

isRemote

public abstract boolean isRemote()

Returns true if the SpanContext was propagated from a remote parent.

Returns:

true if the SpanContext was propagated from a remote parent.

Since:

0.1.0