[larry-robotics#60] Add log and tracing logger

Signed-off-by: Christian Eltzschig <me@elchris.org>

Cargo.toml

@@ -57,6 +57,7 @@ clap = { version = "3.2.0", features = ["derive"] }
 enum-iterator = { version = "1.2.0" }
 generic-tests = { version = "0.1.2" }
 lazy_static = { version = "1.4.0" }
+log = { version = "0.4.20" }
 once_cell = { version = "1.16.0" }
 ouroboros = { version = "0.17.2" }
 pin-init = { version = "0.2.0" }
@@ -65,6 +66,7 @@ sha1_smol = { version = "1.0.0" }
 termsize = { version = "0.1" }
 tiny-fn = { version = "0.1.5" }
 toml = { version = "0.5.9" }
+tracing = { version = "0.1.40" }
 windows-sys = { version = "0.48.0", features = ["Win32_Security", "Win32_Security_Authorization", "Win32_System_Memory", "Win32_System_Threading", "Win32_Foundation", "Win32_System_WindowsProgramming", "Win32_Storage_FileSystem", "Win32_System_IO", "Win32_System_Diagnostics_Debug", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_System_Console", "Win32_Networking_WinSock"] }
 
 [profile.release]

elkodon_bb/log/Cargo.toml

@@ -6,5 +6,13 @@ version = { workspace = true }
 repository = { workspace = true }
 edition = { workspace = true }
 
+[features]
+# Enables https://crates.io/crates/log as default logger
+logger_log = ["dep:log"]
+# Enables https://crates.io/crates/tracing as default logger
+logger_tracing = ["dep:tracing"]
+
 [dependencies]
 termsize = { workspace = true }
+log = { workspace = true, optional = true }
+tracing = { workspace = true, optional = true }

elkodon_bb/log/src/lib.rs

@@ -142,7 +142,13 @@ use std::{
 
 use logger::Logger;
 
+#[cfg(feature = "logger_tracing")]
+static DEFAULT_LOGGER: logger::tracing::Logger = logger::tracing::Logger::new();
+#[cfg(feature = "logger_log")]
+static DEFAULT_LOGGER: logger::log::Logger = logger::log::Logger::new();
+#[cfg(not(any(feature = "logger_tracing", feature = "logger_log")))]
 static DEFAULT_LOGGER: logger::console::Logger = logger::console::Logger::new();
+
 static mut LOGGER: Option<&'static dyn logger::Logger> = None;
 static LOG_LEVEL: AtomicU8 = AtomicU8::new(LogLevel::Info as u8);
 static INIT: Once = Once::new();
@@ -159,7 +165,8 @@ pub enum LogLevel {
     Fatal = 5,
 }
 
-/// Sets the current log level
+/// Sets the current log level. This is ignored for external frameworks like `log` or `tracing`.
+/// Here you have to use the log-level settings of that framework.
 pub fn set_log_level(v: LogLevel) {
     LOG_LEVEL.store(v as u8, Ordering::Relaxed);
 }

elkodon_bb/log/src/logger/log.rs

@@ -0,0 +1,30 @@
+use crate::LogLevel;
+
+pub struct Logger {
+    _priv: (),
+}
+
+impl Logger {
+    pub const fn new() -> Self {
+        Self { _priv: () }
+    }
+}
+
+impl crate::logger::Logger for Logger {
+    fn log(
+        &self,
+        log_level: crate::LogLevel,
+        origin: std::fmt::Arguments,
+        formatted_message: std::fmt::Arguments,
+    ) {
+        let origin = format!("{}", origin);
+        match log_level {
+            LogLevel::Trace => log::trace!(target: &origin, "{}", formatted_message),
+            LogLevel::Debug => log::debug!(target: &origin, "{}", formatted_message),
+            LogLevel::Info => log::info!(target: &origin, "{}", formatted_message),
+            LogLevel::Warn => log::warn!(target: &origin, "{}", formatted_message),
+            LogLevel::Error => log::error!(target: &origin, "{}", formatted_message),
+            LogLevel::Fatal => log::error!(target: &origin, "{}", formatted_message),
+        }
+    }
+}

elkodon_bb/log/src/logger/mod.rs

@@ -3,6 +3,10 @@
 
 pub mod buffer;
 pub mod console;
+#[cfg(feature = "logger_log")]
+pub mod log;
+#[cfg(feature = "logger_tracing")]
+pub mod tracing;
 
 use std::fmt::Arguments;
 

elkodon_bb/log/src/logger/tracing.rs

@@ -0,0 +1,29 @@
+use crate::LogLevel;
+
+pub struct Logger {
+    _priv: (),
+}
+
+impl Logger {
+    pub const fn new() -> Self {
+        Self { _priv: () }
+    }
+}
+
+impl crate::logger::Logger for Logger {
+    fn log(
+        &self,
+        log_level: crate::LogLevel,
+        origin: std::fmt::Arguments,
+        formatted_message: std::fmt::Arguments,
+    ) {
+        match log_level {
+            LogLevel::Trace => tracing::trace!(origin, "{}", formatted_message),
+            LogLevel::Debug => tracing::debug!(origin, "{}", formatted_message),
+            LogLevel::Info => tracing::info!(origin, "{}", formatted_message),
+            LogLevel::Warn => tracing::warn!(origin, "{}", formatted_message),
+            LogLevel::Error => tracing::error!(origin, "{}", formatted_message),
+            LogLevel::Fatal => tracing::error!(origin, "{}", formatted_message),
+        }
+    }
+}