From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 4E0DA1FF163 for ; Thu, 5 Dec 2024 16:10:43 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 25CD81CE17; Thu, 5 Dec 2024 16:10:39 +0100 (CET) From: Gabriel Goller To: pve-devel@lists.proxmox.com Date: Thu, 5 Dec 2024 16:10:32 +0100 Message-Id: <20241205151033.506549-1-g.goller@proxmox.com> X-Mailer: git-send-email 2.39.5 MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.035 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [lib.rs] Subject: [pve-devel] [PATCH v3 1/2] log: add perlmod logger and custom formatter X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Cc: Lukas Wagner Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Add special logger for perlmod. This one will print everything to stderr (which will end up in the tasklog) and the errors to journald. This also includes a custom formatter so that the stderr output will look like: "INFO: sample message". Reported-by: Maximiliano Sandoval Reported-by: Lukas Wagner Signed-off-by: Gabriel Goller --- I didn't include Lukas's T-b as I changed quite a lot on this patch. proxmox-log/src/lib.rs | 39 +++++++++++++++++++++++++++ proxmox-log/src/pve_task_formatter.rs | 31 +++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 proxmox-log/src/pve_task_formatter.rs diff --git a/proxmox-log/src/lib.rs b/proxmox-log/src/lib.rs index 8c74e42b618d..a058eb26ec98 100644 --- a/proxmox-log/src/lib.rs +++ b/proxmox-log/src/lib.rs @@ -5,6 +5,7 @@ use std::env; use std::future::Future; use std::sync::{Arc, Mutex}; +use pve_task_formatter::PveTaskFormatter; use tokio::task::futures::TaskLocalFuture; use tracing_log::{AsLog, LogTracer}; use tracing_subscriber::filter::filter_fn; @@ -15,6 +16,7 @@ use tasklog_layer::TasklogLayer; mod file_logger; pub use file_logger::{FileLogOptions, FileLogger}; +mod pve_task_formatter; mod tasklog_layer; pub use tracing::debug; @@ -191,3 +193,40 @@ pub fn init_cli_logger( LogTracer::init_with_filter(log_level.as_log())?; Ok(()) } + +/// Initialize logger for perlmod +/// +/// This logger will log everything to stderr (which will land in the tasklog +/// with a custom format) and the errors to syslog as well. +pub fn init_perlmod_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::() { + Ok(l) => { + log_level = l; + } + Err(e) => { + eprintln!("env variable {env_var_name} found, but parsing failed: {e:?}"); + } + } + } + let stderr_layer = tracing_subscriber::fmt::layer() + .event_format(PveTaskFormatter {}) + .with_writer(std::io::stderr); + + let registry = tracing_subscriber::registry() + .with( + tracing_journald::layer() + .ok() + .with_filter(filter_fn(|metadata| *metadata.level() == Level::ERROR)) + .with_filter(log_level), + ) + .with(stderr_layer.with_filter(log_level)); + + tracing::subscriber::set_global_default(registry)?; + LogTracer::init_with_filter(log_level.as_log())?; + Ok(()) +} diff --git a/proxmox-log/src/pve_task_formatter.rs b/proxmox-log/src/pve_task_formatter.rs new file mode 100644 index 000000000000..e9866a4b0869 --- /dev/null +++ b/proxmox-log/src/pve_task_formatter.rs @@ -0,0 +1,31 @@ +use std::fmt; +use tracing::{Event, Subscriber}; +use tracing_subscriber::field::VisitOutput; +use tracing_subscriber::fmt::format::{DefaultVisitor, Writer}; +use tracing_subscriber::fmt::{FmtContext, FormatEvent, FormatFields}; +use tracing_subscriber::registry::LookupSpan; + +/// This custom formatter outputs logs as they are visible in the PVE task log. +/// +/// e.g.: "DEBUG: sample message" +pub struct PveTaskFormatter {} + +impl FormatEvent for PveTaskFormatter +where + C: Subscriber + for<'a> LookupSpan<'a>, + N: for<'a> FormatFields<'a> + 'static, +{ + fn format_event( + &self, + _ctx: &FmtContext<'_, C, N>, + mut writer: Writer<'_>, + event: &Event<'_>, + ) -> fmt::Result { + write!(writer, "{}: ", event.metadata().level().as_str())?; + + let mut v = DefaultVisitor::new(writer.by_ref(), true); + event.record(&mut v); + v.finish()?; + writer.write_char('\n') + } +} -- 2.39.5 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel