Class TraceContextFormat

java.lang.Object

io.opencensus.trace.propagation.TextFormat

io.opencensus.implcore.trace.propagation.TraceContextFormat

public class TraceContextFormat
extends TextFormat

Implementation of the TraceContext propagation protocol. See w3c/distributed-tracing.

Nested Class Summary

Nested classes/interfaces inherited from class TextFormat

TextFormat.Getter<C>, TextFormat.Setter<C>

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<String>	FIELDS
private static final int	SPAN_ID_HEX_SIZE
private static final int	SPAN_ID_OFFSET
private static final int	TRACE_ID_HEX_SIZE
private static final int	TRACE_ID_OFFSET
private static final int	TRACE_OPTION_HEX_SIZE
private static final int	TRACE_OPTION_OFFSET
(package private) static final String	TRACEPARENT
private static final char	TRACEPARENT_DELIMITER
private static final int	TRACEPARENT_DELIMITER_SIZE
private static final int	TRACEPARENT_HEADER_SIZE
(package private) static final String	TRACESTATE
private static final Tracestate	TRACESTATE_DEFAULT
private static final char	TRACESTATE_ENTRY_DELIMITER
private static final com.google.common.base.Splitter	TRACESTATE_ENTRY_DELIMITER_SPLITTER
private static final char	TRACESTATE_KEY_VALUE_DELIMITER
private static final int	TRACESTATE_MAX_MEMBERS
private static final int	TRACESTATE_MAX_SIZE
private static final String	VERSION
private static final int	VERSION_SIZE

Constructor Summary

Constructors

Constructor	Description
TraceContextFormat()

Method Summary

Modifier and Type	Method	Description
<C> SpanContext	extract(C carrier, TextFormat.Getter<C> getter)	Extracts the span context from upstream.
List<String>	fields()	The propagation fields defined.
<C> void	inject(SpanContext spanContext, C carrier, TextFormat.Setter<C> setter)	Injects the span context downstream.

Methods inherited from class Object

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

Field Details

TRACESTATE_DEFAULT

private static final Tracestate TRACESTATE_DEFAULT

TRACEPARENT

static final String TRACEPARENT

See Also:

• Constant Field Values

TRACESTATE

static final String TRACESTATE

See Also:

• Constant Field Values

FIELDS

private static final List<String> FIELDS

VERSION

private static final String VERSION

See Also:

• Constant Field Values

VERSION_SIZE

private static final int VERSION_SIZE

See Also:

• Constant Field Values

TRACEPARENT_DELIMITER

private static final char TRACEPARENT_DELIMITER

See Also:

• Constant Field Values

TRACEPARENT_DELIMITER_SIZE

private static final int TRACEPARENT_DELIMITER_SIZE

See Also:

• Constant Field Values

TRACE_ID_HEX_SIZE

private static final int TRACE_ID_HEX_SIZE

See Also:

• Constant Field Values

SPAN_ID_HEX_SIZE

private static final int SPAN_ID_HEX_SIZE

See Also:

• Constant Field Values

TRACE_OPTION_HEX_SIZE

private static final int TRACE_OPTION_HEX_SIZE

See Also:

• Constant Field Values

TRACE_ID_OFFSET

private static final int TRACE_ID_OFFSET

See Also:

• Constant Field Values

SPAN_ID_OFFSET

private static final int SPAN_ID_OFFSET

See Also:

• Constant Field Values

TRACE_OPTION_OFFSET

private static final int TRACE_OPTION_OFFSET

See Also:

• Constant Field Values

TRACEPARENT_HEADER_SIZE

private static final int TRACEPARENT_HEADER_SIZE

See Also:

• Constant Field Values

TRACESTATE_MAX_SIZE

private static final int TRACESTATE_MAX_SIZE

See Also:

• Constant Field Values

TRACESTATE_MAX_MEMBERS

private static final int TRACESTATE_MAX_MEMBERS

See Also:

• Constant Field Values

TRACESTATE_KEY_VALUE_DELIMITER

private static final char TRACESTATE_KEY_VALUE_DELIMITER

See Also:

• Constant Field Values

TRACESTATE_ENTRY_DELIMITER

private static final char TRACESTATE_ENTRY_DELIMITER

See Also:

• Constant Field Values

TRACESTATE_ENTRY_DELIMITER_SPLITTER

private static final com.google.common.base.Splitter TRACESTATE_ENTRY_DELIMITER_SPLITTER

Constructor Details

TraceContextFormat

public TraceContextFormat()

Method Details

fields

public List<String> fields()

Description copied from class: TextFormat

The propagation fields defined. If your carrier is reused, you should delete the fields here before calling TextFormat.inject(SpanContext, Object, Setter).

For example, if the carrier is a single-use or immutable request object, you don't need to clear fields as they couldn't have been set before. If it is a mutable, retryable object, successive calls should clear these fields first.

Specified by:

fields in class TextFormat

inject

public <C> void inject(SpanContext spanContext,
 C carrier,
 TextFormat.Setter<C> setter)

Description copied from class: TextFormat

Injects the span context downstream. For example, as http headers.

Specified by:

inject in class TextFormat

Parameters:

spanContext - possibly not sampled.

carrier - holds propagation fields. For example, an outgoing message or http request.

setter - invoked for each propagation key to add or remove.

extract

public <C> SpanContext extract(C carrier,
 TextFormat.Getter<C> getter)
                        throws SpanContextParseException

Description copied from class: TextFormat

Extracts the span context from upstream. For example, as http headers.

Specified by:

extract in class TextFormat

Parameters:

carrier - holds propagation fields. For example, an outgoing message or http request.

getter - invoked for each propagation key to get.

Throws:

SpanContextParseException - if the input is invalid