Skip to content

logging: fix dead log_info!/log_warn! macros (route through tracing) #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
TheNewAutonomy wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

logging: fix dead log_info!/log_warn! macros (route through tracing) #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions crates/catalyst-utils/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ pub type Signature = [u8; 64];
// Re-export async_trait since many of our traits use it
pub use async_trait::async_trait;

// Re-export tracing so `log_info!`/`log_warn!`/etc (see `logging` module) can forward to it via
// `$crate::tracing::...` without requiring every downstream crate to add its own `tracing` dep.
pub use tracing;

/// System information utilities
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SystemInfo {
Expand Down
56 changes: 32 additions & 24 deletions crates/catalyst-utils/src/logging.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,70 +474,78 @@ pub fn set_node_id(node_id: String) {
}
}

/// Convenience macros for logging
// Convenience macros for logging.
//
// These used to route through `get_logger()`/the `CatalystLogger`/`GLOBAL_LOGGER` machinery
// above, but `get_logger()` was hardcoded to always return `None` (see its doc comment history)
// -- every call through these macros across the whole codebase was a silent no-op in production,
// regardless of whether `init_logger()` had been called. `tracing::info!`/etc are what's actually
// wired up process-wide (via `catalyst-cli`'s `init_logging`/`tracing_subscriber` registry), and
// that wiring is global -- any crate emitting through `tracing` directly gets captured regardless
// of which crate it's called from. So these macros now forward straight to `tracing`, carrying
// `category` along as a structured field, instead of going through the dead custom logger.
#[macro_export]
macro_rules! log_trace {
($category:expr, $($arg:tt)*) => {
if let Some(logger) = $crate::logging::get_logger() {
let _ = logger.trace($category, &format!($($arg)*));
}
$crate::tracing::trace!(category = %$category, $($arg)*)
};
}

#[macro_export]
macro_rules! log_debug {
($category:expr, $($arg:tt)*) => {
if let Some(logger) = $crate::logging::get_logger() {
let _ = logger.debug($category, &format!($($arg)*));
}
$crate::tracing::debug!(category = %$category, $($arg)*)
};
}

#[macro_export]
macro_rules! log_info {
($category:expr, $($arg:tt)*) => {
if let Some(logger) = $crate::logging::get_logger() {
let _ = logger.info($category, &format!($($arg)*));
}
$crate::tracing::info!(category = %$category, $($arg)*)
};
}

#[macro_export]
macro_rules! log_warn {
($category:expr, $($arg:tt)*) => {
if let Some(logger) = $crate::logging::get_logger() {
let _ = logger.warn($category, &format!($($arg)*));
}
$crate::tracing::warn!(category = %$category, $($arg)*)
};
}

#[macro_export]
macro_rules! log_error {
($category:expr, $($arg:tt)*) => {
if let Some(logger) = $crate::logging::get_logger() {
let _ = logger.error($category, &format!($($arg)*));
}
$crate::tracing::error!(category = %$category, $($arg)*)
};
}

#[macro_export]
macro_rules! log_critical {
// tracing has no level above ERROR; tag critical events so they're still distinguishable.
($category:expr, $($arg:tt)*) => {
if let Some(logger) = $crate::logging::get_logger() {
let _ = logger.critical($category, &format!($($arg)*));
}
$crate::tracing::error!(category = %$category, critical = true, $($arg)*)
};
}

/// Macro for logging with structured fields
#[macro_export]
macro_rules! log_with_fields {
($level:expr, $category:expr, $message:expr, $($key:expr => $value:expr),*) => {
if let Some(logger) = $crate::logging::get_logger() {
let fields = vec![$(($key, $value.into())),*];
let _ = logger.log_with_fields($level, $category, $message, &fields);
($level:expr, $category:expr, $message:expr, $($key:expr => $value:expr),* $(,)?) => {{
// Field names must be static for `tracing`'s macros, but these come in as runtime
// expressions, so fold them into the formatted message instead of separate fields.
let mut __catalyst_log_fields = String::new();
$(
__catalyst_log_fields.push_str(&format!(" {}={:?}", $key, $value));
)*
match $level {
$crate::logging::LogLevel::Trace => $crate::tracing::trace!(category = %$category, "{}{}", $message, __catalyst_log_fields),
$crate::logging::LogLevel::Debug => $crate::tracing::debug!(category = %$category, "{}{}", $message, __catalyst_log_fields),
$crate::logging::LogLevel::Info => $crate::tracing::info!(category = %$category, "{}{}", $message, __catalyst_log_fields),
$crate::logging::LogLevel::Warn => $crate::tracing::warn!(category = %$category, "{}{}", $message, __catalyst_log_fields),
$crate::logging::LogLevel::Error => $crate::tracing::error!(category = %$category, "{}{}", $message, __catalyst_log_fields),
$crate::logging::LogLevel::Critical => $crate::tracing::error!(category = %$category, critical = true, "{}{}", $message, __catalyst_log_fields),
}
};
}};
}

// Allow calling logging macros via `catalyst_utils::logging::log_info!` etc.
Expand Down
Loading