instrument_propagator behaviour (instrument v1.0.0)

Pluggable context propagator registry.

This module provides a registry for context propagators that handle injecting and extracting context from carriers (e.g., HTTP headers).

Built-in Propagators

- instrument_propagator_tracecontext - W3C TraceContext - instrument_propagator_baggage - W3C Baggage

Example Usage

  %% Register a propagator
  instrument_propagator:register(instrument_propagator_tracecontext).
 
  %% Get all registered propagators
  Propagators = instrument_propagator:list().
 
  %% Inject context using all propagators
  Carrier = instrument_propagator:inject(#{}).
 
  %% Extract context using all propagators
  Ctx = instrument_propagator:extract(Carrier).

Summary

Callbacks

extract/2

fields/0

inject/2

Functions

extract(Carrier)

Extracts context from a carrier using all registered propagators.

extract(Carrier, Ctx)

Extracts context from a carrier into an existing context.

fields()

Returns all header fields used by registered propagators.

get_propagators()

Gets the list of registered propagators.

inject(Carrier)

Injects context into a carrier using all registered propagators.

inject(Ctx, Carrier)

Injects context into a carrier using all registered propagators.

list()

Lists all registered propagators.

Registers a propagator module.

set_propagators(Modules)

Sets the list of propagators (replacing existing ones).

unregister(Module)

Unregisters a propagator module.

Callbacks

extract/2

-callback extract(Carrier :: map(), Ctx :: map()) -> map().

fields/0

-callback fields() -> [binary()].

inject/2

-callback inject(Ctx :: map(), Carrier :: map()) -> map().

Functions

extract(Carrier)

-spec extract(map()) -> map().

Extracts context from a carrier using all registered propagators.

extract(Carrier, Ctx)

-spec extract(map(), map()) -> map().

Extracts context from a carrier into an existing context.

fields()

-spec fields() -> [binary()].

Returns all header fields used by registered propagators.

get_propagators()

-spec get_propagators() -> [module()].

Gets the list of registered propagators.

inject(Carrier)

-spec inject(map()) -> map().

Injects context into a carrier using all registered propagators.

inject(Ctx, Carrier)

-spec inject(map(), map()) -> map().

Injects context into a carrier using all registered propagators.

list()

-spec list() -> [module()].

Lists all registered propagators.

register(Module)

-spec register(module()) -> ok.

Registers a propagator module.

set_propagators(Modules)

-spec set_propagators([module()]) -> ok.

Sets the list of propagators (replacing existing ones).

unregister(Module)

-spec unregister(module()) -> ok.

Unregisters a propagator module.