all lists on lists.proxmox.com
 help / color / mirror / Atom feed
* [pbs-devel] [PATCH v2] add tracing init_cli_logger and deprecate old one
@ 2024-08-29 13:40 Gabriel Goller
  2024-08-29 13:40 ` [pbs-devel] [PATCH proxmox-backup v2 1/2] move client binaries to tracing Gabriel Goller
  2024-08-30 11:58 ` [pbs-devel] applied: [PATCH v2] add tracing init_cli_logger and deprecate old one Wolfgang Bumiller
  0 siblings, 2 replies; 9+ messages in thread
From: Gabriel Goller @ 2024-08-29 13:40 UTC (permalink / raw)
  To: pbs-devel

Deprecate the proxmox-router init_cli_logger function used in client
binaries such as `proxmox-backup-client`, `proxmox-backup-manager`,
'pxar', etc... Add a new init_cli_logger function that uses tracing
instead of env_logger. It checks if the task is in a workertask and
prints the message either to stdout or to the tasklog (this is
neccessary for commands in proxmox-backup-manager that call api handlers
that start workerthreads from the client).

Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---

v2, thanks @Wolfgang:
 - order imports
 - don't delete old function, but deprecate
 - add stderr warning when log level is not parsable

 proxmox-log/src/lib.rs        | 42 ++++++++++++++++++++++++++++++++++-
 proxmox-router/src/cli/mod.rs |  1 +
 2 files changed, 42 insertions(+), 1 deletion(-)

diff --git a/proxmox-log/src/lib.rs b/proxmox-log/src/lib.rs
index 796d10145b9e..bcde5495dead 100644
--- a/proxmox-log/src/lib.rs
+++ b/proxmox-log/src/lib.rs
@@ -8,7 +8,7 @@ use std::sync::{Arc, Mutex};
 use tokio::task::futures::TaskLocalFuture;
 use tracing::Level;
 use tracing_log::{AsLog, LogTracer};
-use tracing_subscriber::filter::{filter_fn, LevelFilter};
+use tracing_subscriber::filter::filter_fn;
 use tracing_subscriber::prelude::*;
 
 use tasklog_layer::TasklogLayer;
@@ -32,6 +32,7 @@ pub use tracing::trace;
 pub use tracing::trace_span;
 pub use tracing::warn;
 pub use tracing::warn_span;
+pub use tracing_subscriber::filter::LevelFilter;
 
 tokio::task_local! {
     static LOG_CONTEXT: LogContext;
@@ -125,3 +126,42 @@ impl LogContext {
         &self.logger
     }
 }
+
+/// Initialize default logger for CLI binaries
+pub fn init_cli_logger(
+    env_var_name: &str,
+    default_log_level: LevelFilter,
+) -> Result<(), anyhow::Error> {
+    let mut log_level = default_log_level;
+    if let Ok(v) = env::var(env_var_name) {
+        match v.parse::<LevelFilter>() {
+            Ok(l) => {
+                log_level = l;
+            },
+            Err(e) => {
+                eprintln!("env variable PBS_LOG found, but parsing failed: {e:?}");
+            }
+        }
+    }
+
+    let format = tracing_subscriber::fmt::format()
+        .with_level(false)
+        .without_time()
+        .with_target(false)
+        .compact();
+
+    let registry = tracing_subscriber::registry()
+        .with(
+            tracing_subscriber::fmt::layer()
+                .event_format(format)
+                .with_filter(filter_fn(|metadata| {
+                    !LogContext::exists() || *metadata.level() >= Level::ERROR
+                }))
+                .with_filter(log_level),
+        )
+        .with(TasklogLayer {}.with_filter(log_level));
+
+    tracing::subscriber::set_global_default(registry)?;
+    LogTracer::init_with_filter(log_level.as_log())?;
+    Ok(())
+}
diff --git a/proxmox-router/src/cli/mod.rs b/proxmox-router/src/cli/mod.rs
index 3cc41ab3ea94..2b5a69c83dce 100644
--- a/proxmox-router/src/cli/mod.rs
+++ b/proxmox-router/src/cli/mod.rs
@@ -58,6 +58,7 @@ pub use readline::*;
 pub type CompletionFunction = fn(&str, &HashMap<String, String>) -> Vec<String>;
 
 /// Initialize default logger for CLI binaries
+#[deprecated = "use proxmox_log::init_cli_logger instead"]
 pub fn init_cli_logger(env_var_name: &str, default_log_level: &str) {
     env_logger::Builder::from_env(
         env_logger::Env::new().filter_or(env_var_name, default_log_level),
-- 
2.39.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


^ permalink raw reply	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2024-09-03 14:40 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-08-29 13:40 [pbs-devel] [PATCH v2] add tracing init_cli_logger and deprecate old one Gabriel Goller
2024-08-29 13:40 ` [pbs-devel] [PATCH proxmox-backup v2 1/2] move client binaries to tracing Gabriel Goller
2024-08-29 13:41   ` Gabriel Goller
2024-08-30 11:58 ` [pbs-devel] applied: [PATCH v2] add tracing init_cli_logger and deprecate old one Wolfgang Bumiller
2024-09-03 12:10   ` Gabriel Goller
2024-09-03 12:21     ` Wolfgang Bumiller
2024-09-03 12:27       ` Gabriel Goller
2024-09-03 12:38         ` Wolfgang Bumiller
2024-09-03 14:40           ` Gabriel Goller

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal