com.uber.jaeger.propagation

Class B3TextMapCodec

java.lang.Object

com.uber.jaeger.propagation.B3TextMapCodec

All Implemented Interfaces:

Codec<io.opentracing.propagation.TextMap>, Extractor<io.opentracing.propagation.TextMap>, Injector<io.opentracing.propagation.TextMap>

public class B3TextMapCodec
extends java.lang.Object
implements Codec<io.opentracing.propagation.TextMap>

This format is compatible with other Zipkin based trace libraries such as Brave, Wingtips, zipkin-js, etc.

Example usage:

 b3Codec = new B3TextMapCodec();
 tracer = new Tracer.Builder(serviceName, reporter, sampler)
                    .registerInjector(Format.Builtin.HTTP_HEADERS, b3Codec)
                    .registerExtractor(Format.Builtin.HTTP_HEADERS, b3Codec)
                    ...
 

See Instrumenting a Library

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte	DEBUG_FLAG
protected static java.lang.String	FLAGS_NAME
protected static java.lang.String	PARENT_SPAN_ID_NAME
protected static byte	SAMPLED_FLAG
protected static java.lang.String	SAMPLED_NAME
protected static java.lang.String	SPAN_ID_NAME
protected static java.lang.String	TRACE_ID_NAME

Constructor Summary

Constructors

Constructor and Description
B3TextMapCodec()

Method Summary

Modifier and Type	Method and Description
SpanContext	extract(io.opentracing.propagation.TextMap carrier) Called when Tracer.extract(...) is used.
void	inject(SpanContext spanContext, io.opentracing.propagation.TextMap carrier) Called when Tracer.inject(...) is used.

Methods inherited from class java.lang.Object

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

Field Detail

TRACE_ID_NAME

protected static final java.lang.String TRACE_ID_NAME

See Also:

Constant Field Values

SPAN_ID_NAME

protected static final java.lang.String SPAN_ID_NAME

See Also:

Constant Field Values

PARENT_SPAN_ID_NAME

protected static final java.lang.String PARENT_SPAN_ID_NAME

See Also:

Constant Field Values

SAMPLED_NAME

protected static final java.lang.String SAMPLED_NAME

See Also:

Constant Field Values

FLAGS_NAME

protected static final java.lang.String FLAGS_NAME

See Also:

Constant Field Values

SAMPLED_FLAG

protected static final byte SAMPLED_FLAG

See Also:

Constant Field Values

DEBUG_FLAG

protected static final byte DEBUG_FLAG

See Also:

Constant Field Values

Constructor Detail

B3TextMapCodec

public B3TextMapCodec()

Method Detail

inject

public void inject(SpanContext spanContext,
                   io.opentracing.propagation.TextMap carrier)

Description copied from interface: Injector

Called when Tracer.inject(...) is used. It should handle the logic behind injecting propagation scheme specific information into the carrier (e.g. http request headers, amqp message headers, etc.).

All exceptions thrown from this method will be caught and logged on ERROR level so that business code execution isn't affected. If possible, catch implementation specific exceptions and log more meaningful information.

Specified by:

inject in interface Injector<io.opentracing.propagation.TextMap>

Parameters:

spanContext - span context that should be used to pass trace information with the carrier

carrier - holder of data that is used to pass tracing information between processes

See Also:

B3TextMapCodec, TextMapCodec

extract

public SpanContext extract(io.opentracing.propagation.TextMap carrier)

Description copied from interface: Extractor

Called when Tracer.extract(...) is used. It should handle the logic behind extracting propagation-scheme specific information from carrier (e.g. http request headers, amqp message headers, etc.).

This method must not modify the carrier

All exceptions thrown from this method will be caught and logged on WARN level so that business code execution isn't affected. If possible, catch implementation specific exceptions and log more meaningful information.

Specified by:

extract in interface Extractor<io.opentracing.propagation.TextMap>

Parameters:

carrier - input that you extract Span information from, usually TextMap.

Returns:

SpanContext or null if carrier doesn't contain tracing information, it is not valid or is incomplete

See Also:

B3TextMapCodec, TextMapCodec