Add logging infrastructure (#302)

* Add logging dependencies

* Initialise logging

Author: cyqsimon

Cargo.lock

@@ -36,9 +36,13 @@ resolv-conf = "0.7.0"
 pnet_macros_support = "0.34.0"
 anyhow = { version = "1.0.75", features = ["backtrace"] }
 thiserror = "1.0.49"
+log = "0.4.20"
+simplelog = "0.12.1"
+clap-verbosity-flag = "2.0.1"
+derivative = "2.2.0"
 
 [target.'cfg(target_os="windows")'.dependencies]
-netstat2 = "0.9.1"
+netstat2 = "0.9.1" 
 sysinfo = "0.29.10"
 
 [target.'cfg(target_os="linux")'.dependencies]

Cargo.toml

@@ -1,8 +1,11 @@
-use std::net::Ipv4Addr;
+use std::{net::Ipv4Addr, path::PathBuf};
 
 use clap::{Args, Parser};
+use clap_verbosity_flag::{InfoLevel, Verbosity};
+use derivative::Derivative;
 
-#[derive(Clone, Debug, Default, Parser)]
+#[derive(Clone, Debug, Derivative, Parser)]
+#[derivative(Default)]
 #[command(name = "bandwhich", version)]
 pub struct Opt {
     #[arg(short, long)]
@@ -25,6 +28,14 @@ pub struct Opt {
     /// A dns server ip to use instead of the system default
     pub dns_server: Option<Ipv4Addr>,
 
+    #[arg(long)]
+    /// Enable logging to a file
+    pub log_to: Option<PathBuf>,
+
+    #[command(flatten)]
+    #[derivative(Default(value = "Verbosity::new(0, 0)"))]
+    pub verbosity: Verbosity<InfoLevel>,
+
     #[command(flatten)]
     pub render_opts: RenderOpts,
 }

src/cli.rs

@@ -9,6 +9,7 @@ mod tests;
 
 use std::{
     collections::HashMap,
+    fs::File,
     sync::{
         atomic::{AtomicBool, AtomicUsize, Ordering},
         Arc, Mutex, RwLock,
@@ -29,15 +30,26 @@ use network::{
 };
 use pnet::datalink::{DataLinkReceiver, NetworkInterface};
 use ratatui::backend::{Backend, CrosstermBackend};
+use simplelog::WriteLogger;
 
 use crate::cli::Opt;
 
 const DISPLAY_DELTA: Duration = Duration::from_millis(1000);
 
 fn main() -> anyhow::Result<()> {
     let opts = Opt::parse();
-    let os_input = os::get_input(opts.interface.as_deref(), !opts.no_resolve, opts.dns_server)?;
 
+    // init logging
+    if let Some(ref log_path) = opts.log_to {
+        let log_file = File::options().create_new(true).open(log_path)?;
+        WriteLogger::init(
+            opts.verbosity.log_level_filter(),
+            Default::default(),
+            log_file,
+        )?;
+    }
+
+    let os_input = os::get_input(opts.interface.as_deref(), !opts.no_resolve, opts.dns_server)?;
     if opts.raw {
         let terminal_backend = RawTerminalBackend {};
         start(terminal_backend, os_input, opts);