refactor: [#884] move from log to tracing crate

Author: josecelano

packages/located-error/src/lib.rs

@@ -33,7 +33,7 @@ use std::error::Error;
 use std::panic::Location;
 use std::sync::Arc;
 
-use log::debug;
+use tracing::debug;
 
 pub type DynError = Arc<dyn std::error::Error + Send + Sync>;
 

src/app.rs

@@ -23,9 +23,9 @@
 //! - Tracker REST API: the tracker API can be enabled/disabled.
 use std::sync::Arc;
 
-use log::warn;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::Configuration;
+use tracing::warn;
 
 use crate::bootstrap::jobs::{health_check_api, http_tracker, torrent_cleanup, tracker_apis, udp_tracker};
 use crate::servers::registar::Registar;

src/bootstrap/jobs/health_check_api.rs

@@ -14,10 +14,10 @@
 //! Refer to the [configuration documentation](https://docs.rs/torrust-tracker-configuration)
 //! for the API configuration options.
 
-use log::info;
 use tokio::sync::oneshot;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::HealthCheckApi;
+use tracing::info;
 
 use super::Started;
 use crate::servers::health_check_api::server;

src/bootstrap/jobs/http_tracker.rs

@@ -14,9 +14,9 @@ use std::net::SocketAddr;
 use std::sync::Arc;
 
 use axum_server::tls_rustls::RustlsConfig;
-use log::info;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::HttpTracker;
+use tracing::info;
 
 use super::make_rust_tls;
 use crate::core;

src/bootstrap/jobs/mod.rs

@@ -89,10 +89,10 @@ use std::panic::Location;
 use std::sync::Arc;
 
 use axum_server::tls_rustls::RustlsConfig;
-use log::info;
 use thiserror::Error;
 use torrust_tracker_configuration::TslConfig;
 use torrust_tracker_located_error::{DynError, LocatedError};
+use tracing::info;
 
 /// Error returned by the Bootstrap Process.
 #[derive(Error, Debug)]

src/bootstrap/jobs/torrent_cleanup.rs

@@ -13,9 +13,9 @@
 use std::sync::Arc;
 
 use chrono::Utc;
-use log::info;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::v1::core::Core;
+use tracing::info;
 
 use crate::core;
 

src/bootstrap/jobs/tracker_apis.rs

@@ -24,9 +24,9 @@ use std::net::SocketAddr;
 use std::sync::Arc;
 
 use axum_server::tls_rustls::RustlsConfig;
-use log::info;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::{AccessTokens, HttpApi};
+use tracing::info;
 
 use super::make_rust_tls;
 use crate::core;

src/bootstrap/jobs/udp_tracker.rs

@@ -8,9 +8,9 @@
 //! > for the configuration options.
 use std::sync::Arc;
 
-use log::debug;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::UdpTracker;
+use tracing::debug;
 
 use crate::core;
 use crate::servers::registar::ServiceRegistrationForm;

src/bootstrap/logging.rs

@@ -12,55 +12,72 @@
 //! Refer to the [configuration crate documentation](https://docs.rs/torrust-tracker-configuration) to know how to change log settings.
 use std::sync::Once;
 
-use log::{info, LevelFilter};
 use torrust_tracker_configuration::{Configuration, LogLevel};
+use tracing::info;
+use tracing::level_filters::LevelFilter;
 
 static INIT: Once = Once::new();
 
 /// It redirects the log info to the standard output with the log level defined in the configuration
 pub fn setup(cfg: &Configuration) {
-    let level = config_level_or_default(&cfg.core.log_level);
+    let tracing_level = config_level_or_default(&cfg.core.log_level);
 
-    if level == log::LevelFilter::Off {
+    if tracing_level == LevelFilter::OFF {
         return;
     }
 
     INIT.call_once(|| {
-        stdout_config(level);
+        tracing_stdout_init(tracing_level, &TraceStyle::Default);
     });
 }
 
 fn config_level_or_default(log_level: &Option<LogLevel>) -> LevelFilter {
     match log_level {
-        None => log::LevelFilter::Info,
+        None => LevelFilter::INFO,
         Some(level) => match level {
-            LogLevel::Off => LevelFilter::Off,
-            LogLevel::Error => LevelFilter::Error,
-            LogLevel::Warn => LevelFilter::Warn,
-            LogLevel::Info => LevelFilter::Info,
-            LogLevel::Debug => LevelFilter::Debug,
-            LogLevel::Trace => LevelFilter::Trace,
+            LogLevel::Off => LevelFilter::OFF,
+            LogLevel::Error => LevelFilter::ERROR,
+            LogLevel::Warn => LevelFilter::WARN,
+            LogLevel::Info => LevelFilter::INFO,
+            LogLevel::Debug => LevelFilter::DEBUG,
+            LogLevel::Trace => LevelFilter::TRACE,
         },
     }
 }
 
-fn stdout_config(level: LevelFilter) {
-    if let Err(_err) = fern::Dispatch::new()
-        .format(|out, message, record| {
-            out.finish(format_args!(
-                "{} [{}][{}] {}",
-                chrono::Local::now().format("%+"),
-                record.target(),
-                record.level(),
-                message
-            ));
-        })
-        .level(level)
-        .chain(std::io::stdout())
-        .apply()
-    {
-        panic!("Failed to initialize logging.")
-    }
+fn tracing_stdout_init(filter: LevelFilter, style: &TraceStyle) {
+    let builder = tracing_subscriber::fmt().with_max_level(filter);
+
+    let () = match style {
+        TraceStyle::Default => builder.init(),
+        TraceStyle::Pretty(display_filename) => builder.pretty().with_file(*display_filename).init(),
+        TraceStyle::Compact => builder.compact().init(),
+        TraceStyle::Json => builder.json().init(),
+    };
 
     info!("logging initialized.");
 }
+
+#[derive(Debug)]
+pub enum TraceStyle {
+    Default,
+    Pretty(bool),
+    Compact,
+    Json,
+}
+
+impl std::fmt::Display for TraceStyle {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let style = match self {
+            TraceStyle::Default => "Default Style",
+            TraceStyle::Pretty(path) => match path {
+                true => "Pretty Style with File Paths",
+                false => "Pretty Style without File Paths",
+            },
+            TraceStyle::Compact => "Compact Style",
+            TraceStyle::Json => "Json Format",
+        };
+
+        f.write_str(style)
+    }
+}

src/console/ci/e2e/docker.rs

@@ -4,7 +4,7 @@ use std::process::{Command, Output};
 use std::thread::sleep;
 use std::time::{Duration, Instant};
 
-use log::{debug, info};
+use tracing::{debug, info};
 
 /// Docker command wrapper.
 pub struct Docker {}