Skip to main content

Setup

Struct Setup 

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

Builder for the tracing-subscriber config.

All knobs are optional with sensible defaults. Build up the config and call install when done.

Implementations§

Source§

impl Setup

Source

pub fn new() -> Self

New builder with defaults: pretty format, "info,sqlx=warn" filter, no thread IDs, no line numbers, targets shown.

Source

pub fn json(self) -> Self

Output JSON instead of pretty colored format. Recommended for production (Loki / CloudWatch / Datadog all parse JSON).

Source

pub fn with_default_env_filter(self, filter: impl Into<String>) -> Self

Default env-filter when RUST_LOG is unset. Defaults to "info,sqlx=warn".

Source

pub fn without_targets(self) -> Self

Hide event targets (the module path) in pretty output.

Source

pub fn with_thread_ids(self) -> Self

Include thread IDs in events.

Source

pub fn with_line_numbers(self) -> Self

Include source-file line numbers in events. Useful in dev, noisy in prod.

Source

pub fn with_file( self, dir: impl Into<PathBuf>, filename_prefix: impl Into<String>, rotation: Rotation, ) -> Self

Tee logs to a rolling file in dir/filename_prefix.YYYY-MM-DD in addition to stdout. By default rotates daily; pass a different Rotation to override. The directory is created on first write if it doesn’t exist.

File output uses tracing-appender’s non-blocking writer so a stalled disk doesn’t pause request handling — events queue in-memory and drop only under sustained extreme pressure. Closes future-backlog item #1 (“advanced logging config”).

use rustango::logging::{Setup, Rotation};
Setup::new()
    .json()
    .with_file("/var/log/myapp", "app", Rotation::Daily)
    .install();
Source

pub fn file_only(self) -> Self

When Self::with_file is configured, drop the stdout layer so logs land in the rolling file ONLY. No-op when no file sink is configured.

Source

pub fn install(self) -> Option<WorkerGuard>

Apply the config. Uses try_init under the hood — duplicate calls are silently ignored. When Self::with_file is configured, returns the tracing_appender::WorkerGuard that flushes pending writes on drop — keep it alive for the lifetime of the process (typically by stashing in a static or OnceLock). None is returned when no file sink is configured.

Trait Implementations§

Source§

impl Default for Setup

Available on crate feature runtime only.
Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl Freeze for Setup

§

impl RefUnwindSafe for Setup

§

impl Send for Setup

§

impl Sync for Setup

§

impl Unpin for Setup

§

impl UnsafeUnpin for Setup

§

impl UnwindSafe for Setup

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: 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> MaybeMyFromRow for T

Source§

impl<T> MaybeMyLoadRelated for T