Class B3Format

java.lang.Object

io.opencensus.trace.propagation.TextFormat

io.opencensus.implcore.trace.propagation.B3Format

final class B3Format
extends TextFormat

Implementation of the B3 propagation protocol. See b3-propagation.

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 String	FLAGS_VALUE
private static final String	SAMPLED_VALUE
private static final Tracestate	TRACESTATE_DEFAULT
private static final String	UPPER_TRACE_ID
(package private) static final String	X_B3_FLAGS
(package private) static final String	X_B3_PARENT_SPAN_ID
(package private) static final String	X_B3_SAMPLED
(package private) static final String	X_B3_SPAN_ID
(package private) static final String	X_B3_TRACE_ID

Constructor Summary

Constructors

Constructor	Description
B3Format()

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

X_B3_TRACE_ID

static final String X_B3_TRACE_ID

See Also:

• Constant Field Values

X_B3_SPAN_ID

static final String X_B3_SPAN_ID

See Also:

• Constant Field Values

X_B3_PARENT_SPAN_ID

static final String X_B3_PARENT_SPAN_ID

See Also:

• Constant Field Values

X_B3_SAMPLED

static final String X_B3_SAMPLED

See Also:

• Constant Field Values

X_B3_FLAGS

static final String X_B3_FLAGS

See Also:

• Constant Field Values

FIELDS

private static final List<String> FIELDS

UPPER_TRACE_ID

private static final String UPPER_TRACE_ID

See Also:

• Constant Field Values

SAMPLED_VALUE

private static final String SAMPLED_VALUE

See Also:

• Constant Field Values

FLAGS_VALUE

private static final String FLAGS_VALUE

See Also:

• Constant Field Values

Constructor Details

B3Format

B3Format()

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