Struct TextMapSplitPropagator

Source
pub struct TextMapSplitPropagator { /* private fields */ }
Expand description

A text map propagator that uses different propagators for injection and extraction.

This propagator allows for asymmetric context propagation where different propagation strategies can be used for outgoing requests (injection) versus incoming requests (extraction). This is useful when you need to maintain compatibility with multiple tracing systems or protocols.

§Use Cases

  • Migrating between tracing systems while maintaining compatibility
  • Supporting multiple trace context formats in a single service
  • Using environment-specific propagation strategies

Implementations§

Source§

impl TextMapSplitPropagator

Source

pub fn new( extract_propagator: Propagator, inject_propagator: Propagator, ) -> Self

Creates a new split propagator with separate propagators for extraction and injection.

§Arguments
  • extract_propagator: Propagator used for extracting context from incoming requests
  • inject_propagator: Propagator used for injecting context into outgoing requests
§Returns

A new TextMapSplitPropagator instance

Source

pub fn from_env() -> Result<Self, TraceError>

Creates a split propagator based on the OTEL_PROPAGATORS environment variable.

This method reads the OTEL_PROPAGATORS environment variable to determine which propagators to use. The first propagator in the list is used for injection, while all propagators are composed together for extraction.

§Environment Variable Format

The OTEL_PROPAGATORS variable should contain a comma-separated list of propagator names:

  • tracecontext: W3C Trace Context propagator
  • baggage: W3C Baggage propagator
  • b3: B3 single header propagator (requires “zipkin” feature)
  • b3multi: B3 multiple header propagator (requires “zipkin” feature)
  • none: No-op propagator
§Returns

A configured TextMapSplitPropagator on success, or a TraceError if the environment variable contains unsupported propagator names.

§Examples
export OTEL_PROPAGATORS=tracecontext,baggage
use telemetry_rust::propagation::TextMapSplitPropagator;

let propagator = TextMapSplitPropagator::from_env()?;

Trait Implementations§

Source§

impl Debug for TextMapSplitPropagator

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextMapSplitPropagator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl TextMapPropagator for TextMapSplitPropagator

Source§

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

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

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.
Source§

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

Returns iter of fields used by TextMapPropagator
Source§

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

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

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.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,