Struct OtelAxumLayer 

pub struct OtelAxumLayer { /* private fields */ }

layer/middleware for axum:

• propagate OpenTelemetry context (trace_id,…) to server
• create a Span for OpenTelemetry (and tracing) on call

OpenTelemetry context are extracted from tracing’s span.

Implementations

impl OtelAxumLayer

pub fn filter(self, filter: Filter) -> Self

pub fn try_extract_client_ip(self, enable: bool) -> Self

Enable or disable (default) the extraction of client’s ip. Extraction from (in order):

1. http header ‘Forwarded’
2. http header X-Forwarded-For
3. socket connection ip, use the axum::extract::ConnectionInfo (see Router::into_make_service_with_connect_info for more details)
4. empty (failed to extract the information)

The extracted value could an ip v4, ip v6, a string (as Forwarded can use label or hide the client). The extracted value is stored it as client.address in the span/trace

Trait Implementations

impl Clone for OtelAxumLayer

fn clone(&self) -> OtelAxumLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OtelAxumLayer

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

Formats the value using the given formatter.

impl Default for OtelAxumLayer

fn default() -> OtelAxumLayer

Returns the “default value” for a type.

impl<S> Layer<S> for OtelAxumLayer

type Service = OtelAxumService<S>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.