Struct Logger

pub struct Logger {
    pub config: LoggerConfig,
    /* private fields */
}

A high-performance logger utilizing a MPSC channel under the hood.

A logger is initialized with a LoggerConfig to set up different logging levels for stdout, file, and components. The logger spawns a thread that listens for LogEvents sent via an MPSC channel.

Fields

config: LoggerConfig

Configuration for logging levels and behavior.

Implementations

impl Logger

pub fn init_with_env( trader_id: TraderId, instance_id: UUID4, file_config: FileWriterConfig, ) -> Result<LogGuard>

Initializes the logger based on the NAUTILUS_LOG environment variable.

Errors

Returns an error if reading the environment variable or parsing the configuration fails.

pub fn init_with_config( trader_id: TraderId, instance_id: UUID4, config: LoggerConfig, file_config: FileWriterConfig, ) -> Result<LogGuard>

Initializes the logger with the given configuration.

Examples

let config = LoggerConfig::from_spec("stdout=Info;fileout=Debug;RiskEngine=Error");
let file_config = FileWriterConfig::default();
let log_guard = Logger::init_with_config(trader_id, instance_id, config, file_config);

Initializes the logger with the given LoggerConfig and FileWriterConfig.

Errors

Returns an error if the logger fails to register or initialize the background thread.

Trait Implementations

impl Debug for Logger

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

Formats the value using the given formatter.

impl Log for Logger

fn enabled(&self, metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be logged.

fn log(&self, record: &Record<'_>)

Logs the Record.

fn flush(&self)

Flushes any buffered records.