Package io.honeycomb.beeline.tracing.propagation

Interface PropagationCodec<E>

Type Parameters:

E - Type of the transmission format to be decoded/encoded.

All Known Implementing Classes:

HttpHeaderV1PropagationCodec

public interface PropagationCodec<E>

Interface that allows conversion between in-memory PropagationContext and some transmission format of trace data, such as an HTTP header. Propagation contains helpers for this.

Since tracing instrumentation should not be invasive, implementations of this interface must avoid throwing exceptions, and instead return "empty" return values - highlight issues through logging.

Thread-safety

Implementations must be thread-safe and so that they can be shared.

Method Summary

Modifier and Type	Method	Description
PropagationContext	decode(E encodedTrace)	Decode some transmission format into a propagation context.
Optional<E>	encode(PropagationContext context)	Encode the propagation context into a transmission format.

Method Detail

decode

PropagationContext decode(E encodedTrace)

Decode some transmission format into a propagation context.

Parameters:

encodedTrace - to decode to trace.

Returns:

context - "empty" context if parameter is invalid.

encode

Optional<E> encode(PropagationContext context)

Encode the propagation context into a transmission format.

Parameters:

context - to encode

Returns:

encoded context - "empty" optional if invalid or not currently on a trace.