io.jaegertracing.internal.propagation

Class BinaryCodec

java.lang.Object

io.jaegertracing.internal.propagation.BinaryCodec

All Implemented Interfaces:

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

public class BinaryCodec
extends java.lang.Object
implements Codec<io.opentracing.propagation.Binary>

This class is a simple binary codec, mirroring the wire format of the golang binary injector/extractor to be compatible. The go client codec that has defined the wire format used in this module can be found here: https://github.com/jaegertracing/jaeger-client-go/blob/v2.16.0/propagation.go#L177 For reference, the binary format is: | IDs | flags | baggage count | key len | key | value len | value | ... The baggage count and lengths are 32 bit integers (int). IDs are 64 bits integers (long) serialized as: | TraceID high | TraceID low | SpanID | Parent ID |

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BinaryCodec.Builder This class is the builder for the BinaryCodec.

Constructor Summary

Constructors

Constructor and Description
BinaryCodec() Constructor for a Binary Codec.

Method Summary

Modifier and Type	Method and Description
static BinaryCodec.Builder	builder() Returns a builder for BinaryCodec.
JaegerSpanContext	extract(io.opentracing.propagation.Binary carrier) Called when Tracer.extract(io.opentracing.propagation.Format, Object) is used.
void	inject(JaegerSpanContext spanContext, io.opentracing.propagation.Binary carrier) Called when Tracer.inject(io.opentracing.SpanContext, Format, Object) 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

BinaryCodec

public BinaryCodec()

Constructor for a Binary Codec.

Method Detail

inject

public void inject(JaegerSpanContext spanContext,
                   io.opentracing.propagation.Binary carrier)

Description copied from interface: Injector

Called when Tracer.inject(io.opentracing.SpanContext, Format, Object) 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.Binary>

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 JaegerSpanContext extract(io.opentracing.propagation.Binary carrier)

Description copied from interface: Extractor

Called when Tracer.extract(io.opentracing.propagation.Format, Object) 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.Binary>

Parameters:

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

Returns:

JaegerSpanContext 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 BinaryCodec.Builder builder()

Returns a builder for BinaryCodec.

Returns:

Builder