Struct HttpInstrumentation 

pub struct HttpInstrumentation { /* private fields */ }

Available on crate feature observability only.

Configuration for HTTP instrumentation. Convert it with into_layer, or pass it to App::middleware.

Implementations

impl HttpInstrumentation

pub fn new() -> HttpInstrumentation

Tracing on (when the tracing feature is enabled), metrics off until a meter is supplied, no propagator, no exclusions.

pub fn meter(self, meter: &Meter) -> HttpInstrumentation

Available on crate feature metrics only.

Records HTTP metrics with instruments created on meter.

pub fn metrics(self, metrics: HttpMetrics) -> HttpInstrumentation

Available on crate feature metrics only.

Records HTTP metrics with existing instruments.

pub fn tracing(self, enabled: bool) -> HttpInstrumentation

Available on crate feature tracing only.

Enables or disables the per-request span.

pub fn propagator<P>(self, propagator: P) -> HttpInstrumentation

where P: TextMapPropagator + Send + Sync + 'static,

Available on crate feature tracing only.

Extracts the parent context from request headers with propagator (typically W3C TraceContext + Baggage).

pub fn shared_propagator( self, propagator: Arc<dyn TextMapPropagator + Send + Sync>, ) -> HttpInstrumentation

Available on crate feature tracing only.

Like propagator, from a shared instance.

pub fn exclude(self, route: impl Into<String>) -> HttpInstrumentation

Excludes a route template (/health, /users/{id}) — or, for requests that match no route, an exact path — from metrics and tracing.

pub fn scheme(self, scheme: &'static str) -> HttpInstrumentation

The url.scheme reported when the request URI has none (HTTP/1). Set to "https" when TLS terminates in front of the application. Default "http".

pub fn request_id_header(self, name: &str) -> HttpInstrumentation

The header whose value is recorded as kerniq.request_id on the request span. Default x-request-id (set by RequestId).

Panics

Panics if name is not a valid header name.

pub fn into_layer(self) -> HttpLayer

Converts into a Tower layer.

Trait Implementations

impl Clone for HttpInstrumentation

fn clone(&self) -> HttpInstrumentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpInstrumentation

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

Formats the value using the given formatter.

impl Default for HttpInstrumentation

fn default() -> HttpInstrumentation

Returns the “default value” for a type.

impl Middleware for HttpInstrumentation

fn apply<S>(self, router: Router<S>) -> Router<S>

where S: Clone + Send + Sync + 'static,

Applies this middleware to router.