fix: Logger initialization function

Adds a logger initialization function that allows removing the `log` dependencies. Signed-off-by: Jonathan Woollett-Light <[email protected]>
firecracker-microvm · Oct 6, 2023 · 3d07747 · 3d07747
1 parent 332f218
commit 3d07747
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 7 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/src/firecracker/Cargo.toml b/src/firecracker/Cargo.toml
@@ -16,7 +16,6 @@ bench = false
 displaydoc = "0.2.4"
 event-manager = "0.3.0"
 libc = "0.2.148"
-log = "0.4.20"
 serde_json = "1.0.107"
 thiserror = "1.0.49"
 timerfd = "1.5.0"

diff --git a/src/firecracker/src/main.rs b/src/firecracker/src/main.rs
@@ -43,7 +43,7 @@ const MMDS_CONTENT_ARG: &str = "metadata";
 #[derive(Debug, thiserror::Error, displaydoc::Display)]
 enum MainError {
     /// Failed to set the logger: {0}
-    SetLogger(log::SetLoggerError),
+    SetLogger(vmm::logger::LoggerInitError),
     /// Failed to register signal handlers: {0}
     RegisterSignalHandlers(#[source] utils::errno::Error),
     /// Arguments parsing error: {0} \n\nFor more information try --help.
@@ -103,8 +103,7 @@ fn main() -> ExitCode {
 
 fn main_exec() -> Result<(), MainError> {
     // Initialize the logger.
-    log::set_logger(&LOGGER).map_err(MainError::SetLogger)?;
-    log::set_max_level(vmm::logger::DEFAULT_LEVEL);
+    LOGGER.init().map_err(MainError::SetLogger)?;
     info!("Running Firecracker v{FIRECRACKER_VERSION}");
 
     register_signal_handlers().map_err(MainError::RegisterSignalHandlers)?;

diff --git a/src/vmm/src/logger/logging.rs b/src/vmm/src/logger/logging.rs
@@ -36,12 +36,22 @@ pub static LOGGER: Logger = Logger(Mutex::new(LoggerConfiguration {
     },
 }));
 
+/// Error type for [`Logger::init`].
+pub type LoggerInitError = log::SetLoggerError;
+
 /// Error type for [`Logger::update`].
 #[derive(Debug, thiserror::Error)]
 #[error("Failed to open target file: {0}")]
 pub struct LoggerUpdateError(pub std::io::Error);
 
 impl Logger {
+    /// Initialize the logger.
+    pub fn init(&'static self) -> Result<(), LoggerInitError> {
+        log::set_logger(self)?;
+        log::set_max_level(DEFAULT_LEVEL);
+        Ok(())
+    }
+
     /// Applies the given logger configuration the logger.
     pub fn update(&self, config: LoggerConfig) -> Result<(), LoggerUpdateError> {
         let mut guard = self.0.lock().unwrap();

diff --git a/src/vmm/src/logger/mod.rs b/src/vmm/src/logger/mod.rs
@@ -11,8 +11,8 @@ mod metrics;
 
 pub use log::{debug, error, info, log_enabled, trace, warn, Level};
 pub use logging::{
-    LevelFilter, LevelFilterFromStrError, LoggerConfig, LoggerUpdateError, DEFAULT_INSTANCE_ID,
-    DEFAULT_LEVEL, INSTANCE_ID, LOGGER,
+    LevelFilter, LevelFilterFromStrError, LoggerConfig, LoggerInitError, LoggerUpdateError,
+    DEFAULT_INSTANCE_ID, DEFAULT_LEVEL, INSTANCE_ID, LOGGER,
 };
 #[cfg(target_arch = "aarch64")]
 pub use metrics::RTCDeviceMetrics;