com.uber.jaeger.propagation

Class TextMapCodec

java.lang.Object

com.uber.jaeger.propagation.TextMapCodec

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextMapCodec.Builder

Constructor Summary

Constructors

Constructor and Description
TextMapCodec(boolean urlEncoding)

Method Summary

Modifier and Type	Method and Description
static TextMapCodec.Builder	builder() Returns a builder for TextMapCodec.
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextMapCodec

public TextMapCodec(boolean urlEncoding)

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static TextMapCodec.Builder builder()

Returns a builder for TextMapCodec.

Returns:

Builder