Struct opentelemetry_jaeger::Propagator

pub struct Propagator { /* private fields */ }

The Jaeger propagator propagates span contexts in Jaeger propagation format.

Cross-cutting concerns send their state to the next process using Propagators, which are defined as objects used to read and write context data to and from messages exchanged by the applications. Each concern creates a set of Propagators for every supported Propagator type.

Note that jaeger header can be set in http header or encoded as url.

Examples

// setup jaeger propagator
global::set_text_map_propagator(JaegerPropagator::default());
// You also can init propagator with custom header name
// global::set_text_map_propagator(JaegerPropagator::with_custom_header("my-custom-header"));

// before sending requests to downstream services.
let mut headers = std::collections::HashMap::new(); // replace by http header of the outgoing request
let caller_span = global::tracer("caller").start("say hello");
let cx = Context::current_with_span(caller_span);
global::get_text_map_propagator(|propagator| {
    propagator.inject_context(&cx, &mut headers); // propagator serialize the tracing context
});
// Send the request..


// Receive the request sent above on the other service...
// setup jaeger propagator
global::set_text_map_propagator(JaegerPropagator::new());
// You also can init propagator with custom header name
// global::set_text_map_propagator(JaegerPropagator::with_custom_header("my-custom-header"));

let headers = std::collections::HashMap::new(); // replace this with http header map from incoming requests.
let parent_context = global::get_text_map_propagator(|propagator| {
     propagator.extract(&headers)
});

// this span's parent span will be caller_span in send_request functions.
let receiver_span = global::tracer("receiver").start_with_context("hello", &parent_context);

Implementations

impl Propagator

pub fn new() -> Self

Create a Jaeger propagator

pub fn with_custom_header(custom_header_name: &'static str) -> Self

Create a Jaeger propagator with custom header name

pub fn with_custom_header_and_baggage( custom_header_name: &'static str, custom_baggage_prefix: &'static str ) -> Self

Create a Jaeger propagator with custom header name and baggage prefix

NOTE: it’s implicitly fallback to the default header names when the ane of provided custom_* is empty Default header-name is uber-trace-id and baggage-prefix is uberctx- The format of serialized context and baggage’s stays unchanged and not depending on provided header name and prefix.

Trait Implementations

impl Clone for Propagator

fn clone(&self) -> Propagator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Propagator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Propagator

fn default() -> Self

Returns the “default value” for a type.

impl TextMapPropagator for Propagator

fn inject_context(&self, cx: &Context, injector: &mut dyn Injector)

Properly encodes the values of the Context and injects them into the Injector.

fn extract_with_context( &self, cx: &Context, extractor: &dyn Extractor ) -> Context

Retrieves encoded data using the provided [Extractor]. If no data for this format was retrieved OR if the retrieved data is invalid, then the given Context is returned.

fn fields(&self) -> FieldIter<'_>

Returns iter of fields used by [TextMapPropagator]

fn inject(&self, injector: &mut dyn Injector)

Properly encodes the values of the current Context and injects them into the Injector.

fn extract(&self, extractor: &dyn Extractor) -> Context

Retrieves encoded data using the provided [Extractor]. If no data for this format was retrieved OR if the retrieved data is invalid, then the current Context is returned.