mcu-util: better logs (#91)

* mcu-util: better logs

use color-eyre
use RUST_LOG env variable when given
fallback on INFO log level

* mcu-util: remove some allow(dead_code)

mcu-util/Cargo.toml

@@ -16,7 +16,7 @@ async-trait = "0.1.77"
 can-rs = { path = "../can", features = ["isotp"] }
 clap = { workspace = true, features = ["derive"] }
 crc32fast = "1.3.2"
-eyre.workspace = true
+color-eyre.workspace = true
 image = "0.24.8"
 orb-messages.workspace = true
 prost = "0.12.3"

mcu-util/src/logging.rs

@@ -1,22 +1,24 @@
-use eyre::Result;
+use color_eyre::eyre::Result;
 use tracing::level_filters::LevelFilter;
 use tracing_subscriber::layer::SubscriberExt;
 use tracing_subscriber::util::SubscriberInitExt;
-use tracing_subscriber::Layer;
+use tracing_subscriber::{EnvFilter, Layer};
+
+/// Initialize the logger
+pub fn init() -> Result<()> {
+    let filter = EnvFilter::builder()
+        .with_default_directive(LevelFilter::INFO.into())
+        .from_env_lossy();
 
-fn try_init_stdout_logger(loglevel: tracing::Level) -> Result<()> {
     let stdout_log = tracing_subscriber::fmt::layer()
         .compact()
         .with_writer(std::io::stdout)
-        .with_filter(LevelFilter::from_level(loglevel));
-
-    tracing_subscriber::registry().with(stdout_log).try_init()?;
+        .with_filter(filter);
 
-    Ok(())
-}
+    let registry = tracing_subscriber::registry();
+    #[cfg(tokio_unstable)]
+    let registry = registry.with(console_subscriber::spawn());
+    registry.with(stdout_log).try_init()?;
 
-/// Initialize the logger
-pub fn init(loglevel: tracing::Level) -> Result<()> {
-    try_init_stdout_logger(loglevel)?;
     Ok(())
 }

mcu-util/src/main.rs

@@ -3,7 +3,7 @@
 extern crate core;
 use crate::orb::Orb;
 use clap::Parser;
-use eyre::{Context, Result};
+use color_eyre::eyre::{Context, Result};
 use std::io::Write;
 use std::path::PathBuf;
 use std::time::Duration;
@@ -122,11 +122,6 @@ enum SecureElement {
     PowerCycle,
 }
 
-#[cfg(debug_assertions)]
-const LOG_LEVEL: tracing::Level = tracing::Level::DEBUG;
-#[cfg(not(debug_assertions))]
-const LOG_LEVEL: tracing::Level = tracing::Level::INFO;
-
 async fn execute(args: Args) -> Result<()> {
     let mut orb = Orb::new().await?;
 
@@ -190,7 +185,8 @@ async fn execute(args: Args) -> Result<()> {
 
 #[tokio::main]
 async fn main() -> Result<()> {
-    logging::init(LOG_LEVEL)?;
+    color_eyre::install()?;
+    logging::init()?;
 
     let args = Args::parse();
 

mcu-util/src/messaging/can/canfd.rs

@@ -2,7 +2,7 @@ use async_trait::async_trait;
 use can_rs::filter::Filter;
 use can_rs::stream::FrameStream;
 use can_rs::{Frame, Id, CANFD_DATA_LEN};
-use eyre::{eyre, Context, Result};
+use color_eyre::eyre::{eyre, Context, Result};
 use orb_messages::CommonAckError;
 use prost::Message;
 use std::sync::atomic::{AtomicU16, Ordering};

mcu-util/src/messaging/can/isotp.rs

@@ -1,5 +1,5 @@
 use async_trait::async_trait;
-use eyre::{eyre, Context, Result};
+use color_eyre::eyre::{eyre, Context, Result};
 use orb_messages::CommonAckError;
 use prost::Message;
 use std::io::{Read, Write};
@@ -30,7 +30,6 @@ const CAN_ADDR_IS_DEST: u32 = 1 << 9;
 /// for bidirectional communication, addresses are comprised of source and destination digit
 /// along with some flags.
 #[derive(Clone, Copy, PartialEq, Debug)]
-#[allow(dead_code)]
 pub enum IsoTpNodeIdentifier {
     MainMcu = 0x1,
     SecurityMcu = 0x2,
@@ -223,7 +222,6 @@ fn can_rx(
 impl MessagingInterface for CanIsoTpMessaging {
     /// Send payload into McuMessage
     /// One could decide to only listen for ISO-TP message so allow dead code for `send` method
-    #[allow(dead_code)]
     async fn send(&mut self, payload: McuPayload) -> Result<CommonAckError> {
         let ack_number =
             process::id() << 16 | self.ack_num_lsb.load(Ordering::Relaxed) as u32;

mcu-util/src/messaging/mod.rs

@@ -2,7 +2,7 @@ use std::process;
 use std::sync::mpsc;
 
 use async_trait::async_trait;
-use eyre::{eyre, Result};
+use color_eyre::eyre::{eyre, Result};
 use orb_messages::CommonAckError;
 use tracing::debug;
 
@@ -19,7 +19,6 @@ pub enum McuPayload {
 
 /// CAN(-FD) addressing scheme
 #[derive(Clone, Copy, PartialEq, Debug)]
-#[allow(dead_code)]
 pub enum Device {
     Main = 0x01,
     Security = 0x02,

mcu-util/src/messaging/serial/mod.rs

@@ -1,6 +1,6 @@
 use crate::messaging::{Device, McuPayload, MessagingInterface};
 use async_trait::async_trait;
-use eyre::{eyre, Result};
+use color_eyre::eyre::{eyre, Result};
 use orb_messages::CommonAckError;
 use prost::Message;
 use std::sync::atomic::{AtomicU16, Ordering};

mcu-util/src/orb/dfu.rs

@@ -1,4 +1,4 @@
-use eyre::{eyre, Result};
+use color_eyre::eyre::{eyre, Result};
 use orb_messages::mcu_main as main_messaging;
 use orb_messages::mcu_sec as sec_messaging;
 use std::cmp::min;

mcu-util/src/orb/main_board.rs

@@ -1,5 +1,5 @@
 use async_trait::async_trait;
-use eyre::{eyre, Context, Result};
+use color_eyre::eyre::{eyre, Context, Result};
 use orb_messages::{mcu_main as main_messaging, CommonAckError};
 use std::ops::Sub;
 use std::sync::mpsc;

mcu-util/src/orb/mod.rs

@@ -2,7 +2,7 @@ use std::fmt::{Display, Formatter};
 use std::time::Duration;
 
 use async_trait::async_trait;
-use eyre::Result;
+use color_eyre::eyre::Result;
 use orb_messages::mcu_main as main_messaging;
 use orb_messages::mcu_sec as sec_messaging;
 

mcu-util/src/orb/security_board.rs

@@ -1,5 +1,5 @@
 use async_trait::async_trait;
-use eyre::{eyre, Context, Result};
+use color_eyre::eyre::{eyre, Context, Result};
 use orb_messages::mcu_sec::battery_status::BatteryState;
 use orb_messages::{mcu_sec as security_messaging, CommonAckError};
 use std::ops::Sub;