From 36074307b7c53f80937d3745d8bc5dde8a13f0e1 Mon Sep 17 00:00:00 2001 From: Aleksander Date: Sun, 9 Mar 2025 18:05:18 +0100 Subject: [PATCH] Use tracing-subscriber for logging (#175) --- Cargo.lock | 119 +++++++++++++++++++++++++++++++++----------- Cargo.toml | 3 +- src/config_wayvr.rs | 4 +- src/main.rs | 78 +++++++++++++++++------------ 4 files changed, 141 insertions(+), 63 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 76c7441..3af5227 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -494,7 +494,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d123397e75f904758fef490775a00b0ada545ab409cb0163d919799e5a30119b" dependencies = [ "autocxx-engine", - "env_logger 0.9.3", + "env_logger", "indexmap 1.9.3", "syn 2.0.98", ] @@ -1509,16 +1509,6 @@ dependencies = [ "syn 2.0.98", ] -[[package]] -name = "env_filter" -version = "0.1.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "186e05a59d4c50738528153b83b0b0194d3a29507dfec16eccd4b342903397d0" -dependencies = [ - "log", - "regex", -] - [[package]] name = "env_logger" version = "0.9.3" @@ -1532,19 +1522,6 @@ dependencies = [ "termcolor", ] -[[package]] -name = "env_logger" -version = "0.11.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dcaee3d8e3cfc3fd92428d477bc97fc29ec8716d180c0d74c643bb26166660e0" -dependencies = [ - "anstream", - "anstyle", - "env_filter", - "humantime", - "log", -] - [[package]] name = "equivalent" version = "1.0.2" @@ -2514,6 +2491,15 @@ dependencies = [ "libc", ] +[[package]] +name = "matchers" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8263075bb86c5a1b1427b5ae862e8889656f126e9f77c484496e8b47cf5c5558" +dependencies = [ + "regex-automata 0.1.10", +] + [[package]] name = "memchr" version = "2.7.4" @@ -2705,6 +2691,16 @@ dependencies = [ "winapi", ] +[[package]] +name = "nu-ansi-term" +version = "0.46.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77a8165726e8236064dbb45459242600304b42a5ea24ee2948e18e023bf7ba84" +dependencies = [ + "overload", + "winapi", +] + [[package]] name = "num-derive" version = "0.4.2" @@ -3045,6 +3041,12 @@ dependencies = [ "pin-project-lite", ] +[[package]] +name = "overload" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b15813163c1d831bf4a13c3610c05c0d03b39feb07f7e09fa234dac9b15aaf39" + [[package]] name = "ovr_overlay" version = "0.0.0" @@ -3539,8 +3541,17 @@ checksum = "b544ef1b4eac5dc2db33ea63606ae9ffcfac26c1416a2806ae0bf5f56b201191" dependencies = [ "aho-corasick", "memchr", - "regex-automata", - "regex-syntax", + "regex-automata 0.4.9", + "regex-syntax 0.8.5", +] + +[[package]] +name = "regex-automata" +version = "0.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c230d73fb8d8c1b9c0b3135c5142a8acee3a0558fb8db5cf1cb65f8d7862132" +dependencies = [ + "regex-syntax 0.6.29", ] [[package]] @@ -3551,9 +3562,15 @@ checksum = "809e8dc61f6de73b46c85f4c96486310fe304c434cfa43669d7b40f711150908" dependencies = [ "aho-corasick", "memchr", - "regex-syntax", + "regex-syntax 0.8.5", ] +[[package]] +name = "regex-syntax" +version = "0.6.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f162c6dd7b008981e4d40210aca20b4bd0f9b60ca9271061b07f78537722f2e1" + [[package]] name = "regex-syntax" version = "0.8.5" @@ -3820,6 +3837,15 @@ dependencies = [ "roxmltree", ] +[[package]] +name = "sharded-slab" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f40ca3c46823713e0d4209592e8d6e826aa57e928f09752619fc696c499637f6" +dependencies = [ + "lazy_static", +] + [[package]] name = "shlex" version = "1.3.0" @@ -4240,6 +4266,36 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e672c95779cf947c5311f83787af4fa8fffd12fb27e4993211a84bdfd9610f9c" dependencies = [ "once_cell", + "valuable", +] + +[[package]] +name = "tracing-log" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee855f1f400bd0e5c02d150ae5de3840039a3f54b025156404e34c23c03f47c3" +dependencies = [ + "log", + "once_cell", + "tracing-core", +] + +[[package]] +name = "tracing-subscriber" +version = "0.3.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8189decb5ac0fa7bc8b96b7cb9b2701d60d48805aca84a238004d665fcc4008" +dependencies = [ + "matchers", + "nu-ansi-term", + "once_cell", + "regex", + "sharded-slab", + "smallvec", + "thread_local", + "tracing", + "tracing-core", + "tracing-log", ] [[package]] @@ -4335,6 +4391,12 @@ dependencies = [ "rand 0.9.0", ] +[[package]] +name = "valuable" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65" + [[package]] name = "version-compare" version = "0.2.0" @@ -5134,7 +5196,6 @@ dependencies = [ "cstr", "ctrlc", "dbus", - "env_logger 0.11.6", "fontconfig-rs", "freetype-rs", "futures", @@ -5167,6 +5228,8 @@ dependencies = [ "strum", "sysinfo", "thiserror 2.0.11", + "tracing", + "tracing-subscriber", "uuid", "vulkano", "vulkano-shaders", diff --git a/Cargo.toml b/Cargo.toml index 80e3707..b13aac4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -19,7 +19,6 @@ config = "0.14.0" cstr = "0.2.12" ctrlc = { version = "3.4.4", features = ["termination"] } dbus = { version = "0.9.7" } -env_logger = "0.11.5" fontconfig-rs = "0.1.1" freetype-rs = "0.36.0" # latest version supported on ubuntu 22.04 futures = "0.3.30" @@ -69,6 +68,8 @@ image_dds = { version = "0.6.0", default-features = false, features = [ "ddsfile", ] } mint = "0.5.9" +tracing-subscriber = { version = "0.3.19", features = ["env-filter"] } +tracing = "0.1.41" ################################ #WayVR-only deps diff --git a/src/config_wayvr.rs b/src/config_wayvr.rs index 83a5e1b..5c62ff5 100644 --- a/src/config_wayvr.rs +++ b/src/config_wayvr.rs @@ -200,7 +200,9 @@ impl WayVRConfig { if primary_count > 1 { anyhow::bail!("Number of primary displays is more than 1") } else if primary_count == 0 { - log::warn!("No primary display specified"); + log::warn!( + "No primary display specified. External Wayland applications will not be attached." + ); } for (catalog_name, catalog) in &self.catalogs { diff --git a/src/main.rs b/src/main.rs index ec7b663..c68968b 100644 --- a/src/main.rs +++ b/src/main.rs @@ -22,6 +22,8 @@ use std::{ use clap::Parser; use sysinfo::Pid; +use tracing::level_filters::LevelFilter; +use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt, EnvFilter}; /// The lightweight desktop overlay for OpenVR and OpenXR #[derive(Default, Parser, Debug)] @@ -171,51 +173,61 @@ fn args_get_openxr(_args: &Args) -> bool { } fn logging_init(args: &mut Args) -> anyhow::Result<()> { - let log_file = args + let log_file_path = args .log_to .take() .or_else(|| std::env::var("WLX_LOGFILE").ok()) - .or_else(|| Some("/tmp/wlx.log".to_string())); + .unwrap_or(String::from("/tmp/wlx.log")); - if let Some(log_to) = log_file.filter(|s| !s.is_empty()) { - if let Err(e) = file_logging_init(&log_to) { - log::error!("Failed to initialize file logging: {}", e); - env_logger::init(); + let file_writer = match std::fs::OpenOptions::new() + .write(true) + .truncate(true) + .open(&log_file_path) + { + Ok(file) => { + println!("Logging to {}", &log_file_path); + Some(file) } + Err(e) => { + println!("Failed to open log file (path: {:?}): {}", e, log_file_path); + None + } + }; + + let registry = tracing_subscriber::registry() + .with( + tracing_subscriber::fmt::layer() + .pretty() + .with_writer(std::io::stderr), + ) + .with( + /* read RUST_LOG env var */ + EnvFilter::builder() + .with_default_directive(LevelFilter::INFO.into()) + .from_env_lossy() + .add_directive("zbus=warn".parse().unwrap()) + .add_directive("wlx_capture::wayland=info".parse().unwrap()) + .add_directive("smithay=debug".parse().unwrap()), /* GLES render spam */ + ); + + if let Some(writer) = file_writer { + registry + .with( + tracing_subscriber::fmt::layer() + .with_file(true) + .with_line_number(true) + .with_writer(writer) + .with_ansi(false), + ) + .init(); } else { - env_logger::init(); + registry.init(); } log_panics::init(); Ok(()) } -fn file_logging_init(log_to: &str) -> anyhow::Result<()> { - use std::io::Write; - let target = Box::new(std::fs::File::create(log_to)?); - - env_logger::Builder::new() - .target(env_logger::Target::Pipe(target)) - .filter(None, log::LevelFilter::Info) - .filter_module("zbus", log::LevelFilter::Warn) - .parse_default_env() - .format(|buf, record| { - eprintln!("[{}] {}", record.level(), record.args()); - writeln!( - buf, - "[{} {} {}] {}", - chrono::Local::now().format("%H:%M:%S%.3f"), - record.level(), - record.module_path().unwrap_or_default(), - record.args() - ) - }) - .init(); - - println!("Logging to: {}", log_to); - Ok(()) -} - fn ensure_single_instance(replace: bool) -> bool { let mut path = std::env::var("XDG_RUNTIME_DIR") .map(PathBuf::from)