lightspeed_logger/
lib.rs

1pub mod config;
2pub mod utils;
3
4use std::error::Error;
5use std::fmt::{Display, Formatter};
6use std::str::FromStr;
7use tracing::Subscriber;
8use tracing_appender::non_blocking::WorkerGuard;
9use tracing_appender::rolling::RollingFileAppender;
10use tracing_subscriber::util::SubscriberInitExt;
11use tracing_subscriber::{filter::Targets, fmt::Layer, layer::SubscriberExt};
12
13#[derive(Debug)]
14pub enum LoggerError {
15    LoggerConfigurationError { message: String },
16}
17impl Display for LoggerError {
18    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
19        match self {
20            LoggerError::LoggerConfigurationError { message } => write!(f, "LoggerConfigurationError: [{message}]"),
21        }
22    }
23}
24
25impl Error for LoggerError {}
26
27impl From<log::SetLoggerError> for LoggerError {
28    fn from(error: log::SetLoggerError) -> Self {
29        LoggerError::LoggerConfigurationError { message: format!("{error}") }
30    }
31}
32
33impl From<std::io::Error> for LoggerError {
34    fn from(error: std::io::Error) -> Self {
35        LoggerError::LoggerConfigurationError { message: format!("{error}") }
36    }
37}
38
39/// Configure a simple global logger that prints to stdout
40pub fn setup_stdout_logger(logger_filter: &str, use_ansi: bool) -> Result<(), LoggerError> {
41    let env_filter = Targets::from_str(logger_filter).map_err(|err| LoggerError::LoggerConfigurationError {
42        message: format!("Cannot parse the env_filter: [{logger_filter}]. err: {err:?}"),
43    })?;
44
45    let subscriber = tracing_subscriber::registry().with(env_filter).with(Layer::new().with_ansi(use_ansi));
46    set_global_logger(subscriber)
47}
48
49/// Configure the global logger
50pub fn setup_logger(logger_config: &config::LoggerConfig) -> Result<Option<WorkerGuard>, LoggerError> {
51    let env_filter =
52        Targets::from_str(&logger_config.env_filter).map_err(|err| LoggerError::LoggerConfigurationError {
53            message: format!("Cannot parse the env_filter: [{}]. err: {:?}", logger_config.env_filter, err),
54        })?;
55
56    let (file_subscriber, file_guard) = if logger_config.file_output.file_output_enabled {
57        let file_appender = RollingFileAppender::new(
58            logger_config.file_output.file_output_rotation.to_tracing_appender_rotation(),
59            &logger_config.file_output.file_output_directory,
60            &logger_config.file_output.file_output_name_prefix,
61        );
62
63        let (non_blocking, guard) = tracing_appender::non_blocking(file_appender);
64        (Some(Layer::new().with_ansi(false).with_writer(non_blocking)), Some(guard))
65    } else {
66        (None, None)
67    };
68
69    let stdout_subscriber = if logger_config.stdout_output.stdout_enabled {
70        Some(Layer::new().with_ansi(logger_config.stdout_output.stdout_use_ansi_colors))
71    } else {
72        None
73    };
74
75    let subscriber = tracing_subscriber::registry().with(env_filter).with(file_subscriber).with(stdout_subscriber);
76    set_global_logger(subscriber)?;
77
78    Ok(file_guard)
79}
80
81fn set_global_logger<S>(subscriber: S) -> Result<(), LoggerError>
82where
83    S: Subscriber + Send + Sync + 'static,
84{
85    subscriber.try_init().map_err(|err| LoggerError::LoggerConfigurationError {
86        message: format!("Cannot start the logger. err: {err:?}"),
87    })
88}
lightspeed_logger/lib.rs

lightspeed_logger/
lib.rs
