Skip to main content

CallLogging

Struct CallLogging 

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

A Plugin that adds structured per-request logging to a Churust application.

CallLogging installs a single middleware in the Phase::Monitoring phase. For every request it records the HTTP method, request path, response status code, and elapsed wall-clock time in milliseconds, emitting them as a single tracing event.

§Default log level

Unless overridden with CallLogging::level, events are emitted at Level::INFO.

§Examples

§Basic usage (default INFO level)

use churust_core::{Churust, Call, TestClient};
use churust_logging::CallLogging;

let app = Churust::server()
    .install(CallLogging::new())
    .routing(|r| {
        r.get("/ping", |_c: Call| async { "pong" });
    })
    .build();

let res = TestClient::new(app).get("/ping").send().await;
assert_eq!(res.status().as_u16(), 200);

§Custom log level (DEBUG)

use churust_core::{Churust, Call, TestClient};
use churust_logging::CallLogging;
use tracing::Level;

let app = Churust::server()
    .install(CallLogging::new().level(Level::DEBUG))
    .routing(|r| {
        r.get("/", |_c: Call| async { "hi" });
    })
    .build();

let res = TestClient::new(app).get("/").send().await;
assert_eq!(res.status().as_u16(), 200);

Implementations§

Source§

impl CallLogging

Source

pub fn new() -> Self

Creates a new CallLogging plugin with the default log level (Level::INFO).

Use CallLogging::level on the returned value to select a different severity level before passing the plugin to AppBuilder::install.

§Examples
use churust_logging::CallLogging;

let plugin = CallLogging::new();
Source

pub fn level(self, level: Level) -> Self

Overrides the tracing level at which request events are emitted.

All five standard tracing levels are supported: Level::ERROR, Level::WARN, Level::INFO (default), Level::DEBUG, and Level::TRACE.

Choosing a lower level (e.g. DEBUG or TRACE) is useful in development where you want request logs without cluttering production output. Choosing a higher level (WARN or ERROR) lets you capture only unexpected or slow requests when combined with a filtered subscriber.

§Arguments
§Examples
use churust_logging::CallLogging;
use tracing::Level;

// Emit request logs at TRACE level (very verbose).
let plugin = CallLogging::new().level(Level::TRACE);

// Emit request logs at WARN level (production-quiet).
let plugin = CallLogging::new().level(Level::WARN);

Trait Implementations§

Source§

impl Clone for CallLogging

Source§

fn clone(&self) -> CallLogging

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CallLogging

Source§

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

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

impl Default for CallLogging

Source§

fn default() -> Self

Creates a CallLogging plugin with Level::INFO as the default log level.

This is equivalent to calling CallLogging::new().

Source§

impl Plugin for CallLogging

Source§

fn install(self: Box<Self>, app: &mut AppBuilder)

Install this plugin into the builder (register middleware, state, etc.). Consumes the boxed plugin.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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