Skip to main content

RequestLogger

Struct RequestLogger 

Source
pub struct RequestLogger<'a> { /* private fields */ }
Expand description

A per-request logger that captures context and emits logs.

This struct is typically created once per request and provides logging methods that automatically include request context.

§Example

use fastapi_core::logging::RequestLogger;

async fn handler(ctx: &RequestContext) -> impl IntoResponse {
    let logger = RequestLogger::new(ctx, LogConfig::production());

    logger.info("Request started");
    logger.debug_with_fields("Processing", |e| e.field("path", ctx.path()));

    "ok"
}

Implementations§

Source§

impl<'a> RequestLogger<'a>

Source

pub fn new(ctx: &'a RequestContext, config: LogConfig) -> Self

Creates a new request logger.

Source

pub fn is_enabled(&self, level: LogLevel) -> bool

Returns true if the given log level is enabled.

Source

pub fn emit(&self, entry: LogEntry)

Emits a log entry if the level is enabled.

Source

pub fn trace(&self, message: impl Into<String>)

Logs a message at TRACE level.

Source

pub fn debug(&self, message: impl Into<String>)

Logs a message at DEBUG level.

Source

pub fn info(&self, message: impl Into<String>)

Logs a message at INFO level.

Source

pub fn warn(&self, message: impl Into<String>)

Logs a message at WARN level.

Source

pub fn error(&self, message: impl Into<String>)

Logs a message at ERROR level.

Source

pub fn trace_with_fields<F>(&self, message: impl Into<String>, f: F)
where F: FnOnce(LogEntry) -> LogEntry,

Logs with custom field builder at TRACE level.

Source

pub fn debug_with_fields<F>(&self, message: impl Into<String>, f: F)
where F: FnOnce(LogEntry) -> LogEntry,

Logs with custom field builder at DEBUG level.

Source

pub fn info_with_fields<F>(&self, message: impl Into<String>, f: F)
where F: FnOnce(LogEntry) -> LogEntry,

Logs with custom field builder at INFO level.

Source

pub fn warn_with_fields<F>(&self, message: impl Into<String>, f: F)
where F: FnOnce(LogEntry) -> LogEntry,

Logs with custom field builder at WARN level.

Source

pub fn error_with_fields<F>(&self, message: impl Into<String>, f: F)
where F: FnOnce(LogEntry) -> LogEntry,

Logs with custom field builder at ERROR level.

Source

pub fn span(&self, name: impl Into<String>) -> Span

Creates a timing span.

Source

pub fn span_auto(&self, name: impl Into<String>) -> AutoSpan

Creates an auto-ending span.

Auto Trait Implementations§

§

impl<'a> Freeze for RequestLogger<'a>

§

impl<'a> !RefUnwindSafe for RequestLogger<'a>

§

impl<'a> Send for RequestLogger<'a>

§

impl<'a> Sync for RequestLogger<'a>

§

impl<'a> Unpin for RequestLogger<'a>

§

impl<'a> !UnwindSafe for RequestLogger<'a>

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> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> 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<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> ResponseProduces<T> for T