chore: Migrate all tracing events that touch errors to log_error! to ensure consistent field naming

Author: LukeMathWalker

libs/Cargo.lock

@@ -79,6 +79,7 @@ hyper-util = { workspace = true, features = [
 ], optional = true }
 socket2 = { workspace = true, optional = true }
 smallvec = { workspace = true }
+tracing_log_error = { version = "0.1.68", path = "../tracing_log_error" }
 px_workspace_hack = { version = "0.1", path = "../px_workspace_hack" }
 
 [dev-dependencies]

libs/pavex/Cargo.toml

@@ -825,13 +825,10 @@ impl Blueprint {
     /// ```rust
     /// use pavex::f;
     /// use pavex::blueprint::Blueprint;
+    /// use tracing_log_error::log_error;
     ///
     /// pub fn error_logger(e: &pavex::Error) {
-    ///     tracing::error!(
-    ///         error.msg = %e,
-    ///         error.details = ?e,
-    ///         "An error occurred while handling a request"
-    ///     );
+    ///     log_error!(e, "An error occurred while handling a request");
     /// }
     ///
     /// # fn main() {

libs/pavex/src/blueprint/blueprint.rs

@@ -1,5 +1,7 @@
 use std::num::NonZeroUsize;
 
+use tracing_log_error::log_error;
+
 #[derive(Debug, Clone)]
 /// All the available options for customizing the behaviour of a [`Server`](super::Server).
 ///
@@ -23,11 +25,12 @@ impl ServerConfiguration {
             Ok(n) => n,
             Err(e) => {
                 let fallback = NonZeroUsize::new(2).unwrap();
-                tracing::warn!(
-                    error.msg = %e,
-                    error.details = ?e,
+                log_error!(
+                    e,
+                    level: tracing::Level::WARN,
                     "Failed to determine the amount of available parallelism. \
-                    Setting the number of worker threads to a fallback value of {}", fallback);
+                    Setting the number of worker threads to a fallback value of {}",
+                    fallback);
                 fallback
             }
         };
@@ -41,7 +44,7 @@ impl ServerConfiguration {
     ///
     /// It relies on [`std::thread::available_parallelism`] to determine the available parallelism.
     /// On most platforms, this is the number of physical CPU cores available. If the available
-    /// parallelism cannot be determined, it defaults to 2.  
+    /// parallelism cannot be determined, it defaults to 2.
     ///
     /// ## Logical vs physical Cores
     ///

libs/pavex/src/server/configuration.rs

@@ -9,6 +9,7 @@ use std::thread;
 use tokio::net::TcpStream;
 use tokio::sync::mpsc::error::TrySendError;
 use tokio::task::{JoinError, JoinSet, LocalSet};
+use tracing_log_error::log_error;
 
 use crate::connection::ConnectionInfo;
 use crate::server::configuration::ServerConfiguration;
@@ -200,9 +201,9 @@ where
                     Ok((connection, remote_peer)) => return (incoming, connection, remote_peer),
                     Err(e) => {
                         if is_rt_shutdown_err(&e) {
-                            tracing::debug!(error.msg = %e, error.details = ?e, "Failed to accept connection");
+                            log_error!(e, level: tracing::Level::DEBUG, "Failed to accept connection");
                         } else {
-                            tracing::info!(error.msg = %e, error.details = ?e, "Failed to accept connection");
+                            log_error!(e, level: tracing::Level::INFO, "Failed to accept connection");
                         }
                         continue;
                     }
@@ -331,9 +332,8 @@ where
             }
         };
 
-        tracing::error!(
-            error.msg = %error,
-            error.details = ?error,
+        log_error!(
+            error,
             "Failed to accept new connections. The acceptor thread will exit now."
         );
     }

libs/pavex/src/server/server_handle.rs

@@ -7,6 +7,7 @@ use anyhow::Context;
 use hyper_util::rt::TokioIo;
 use tokio::net::TcpStream;
 use tokio::sync::mpsc::error::TrySendError;
+use tracing_log_error::log_error;
 
 use crate::connection::ConnectionInfo;
 use crate::server::ShutdownMode;
@@ -273,11 +274,7 @@ where
             let builder = hyper_util::server::conn::auto::Builder::new(LocalExec);
             let connection = TokioIo::new(connection);
             if let Err(e) = builder.serve_connection(connection, handler).await {
-                tracing::warn!(
-                    error.message = %e,
-                    error.details = ?e,
-                    "Failed to serve an incoming connection"
-                );
+                log_error!(*e, level: tracing::Level::WARN, "Failed to serve an incoming connection");
             }
         });
     }

libs/pavex/src/server/worker.rs

@@ -22,8 +22,9 @@ anyhow = { workspace = true }
 [dependencies]
 pavexc_cli_client = { path = "../pavexc_cli_client", version = "0.1.68" }
 pavex_cli_deps = { path = "../pavex_cli_deps", version = "0.1.68" }
-clap = { workspace = true, features = ["derive", "env"] }
 pavex_miette = { path = "../pavex_miette", version = "0.1.68" }
+tracing_log_error = { version = "0.1.68", path = "../tracing_log_error" }
+clap = { workspace = true, features = ["derive", "env"] }
 miette = { workspace = true }
 fs-err = { workspace = true }
 tracing-subscriber = { workspace = true, features = ["fmt", "env-filter"] }

libs/pavex_cli/Cargo.toml

@@ -8,6 +8,7 @@ use jsonwebtoken::jwk::JwkSet;
 use redact::Secret;
 use time::Duration;
 use token_cache::CliTokenDiskCache;
+use tracing_log_error::log_error;
 
 mod token;
 mod token_cache;
@@ -58,7 +59,7 @@ pub fn background_token_refresh(
             .unwrap();
         rt.block_on(async {
             if let Err(e) = _token_refresh(&key_set, &locator, activation_key).await {
-                tracing::warn!(error.msg = %e, error.details = ?e, "Failed to refresh the CLI token in the background")
+                log_error!(*e, level: tracing::Level::WARN, "Failed to refresh the CLI token in the background");
             }
         });
     });
@@ -106,7 +107,7 @@ async fn _check_activation_with_key(
             None
         }
         Err(e) => {
-            tracing::error!(error.msg = %e, error.details = ?e, "Failed to retrieve a cached token from disk", );
+            log_error!(*e, "Failed to retrieve a cached token from disk");
             None
         }
     };
@@ -115,11 +116,7 @@ async fn _check_activation_with_key(
     if let Some(cached_jwt) = cached_jwt {
         match cached_jwt.validate(key_set) {
             Err(e) => {
-                tracing::warn!(
-                    error.msg = %e,
-                    error.details = ?e,
-                    "The cached CLI token is invalid. Obtaining a new one from Pavex's API.",
-                );
+                log_error!(*e, level: tracing::Level::WARN, "The cached CLI token is invalid. Obtaining a new one from Pavex's API.");
             }
             Ok(proof) => {
                 claims = Some(proof);
@@ -138,11 +135,7 @@ async fn _check_activation_with_key(
             // We have a fresh token. Let's cache it to disk to avoid hitting the API
             // the next time Pavex CLI is invoked.
             if let Err(e) = cache.upsert_token(jwt.raw().clone()).await {
-                tracing::warn!(
-                    error.msg = %e,
-                    error.details = ?e,
-                    "Failed to save the fresh CLI token to disk",
-                );
+                log_error!(*e, level: tracing::Level::WARN, "Failed to save the fresh CLI token to disk");
             }
 
             claims

libs/pavex_cli/src/activation/mod.rs

@@ -3,6 +3,7 @@ use cargo_like_utils::shell::Shell;
 use std::io::{ErrorKind, IsTerminal};
 use std::path::{Path, PathBuf};
 use std::process::ExitCode;
+use tracing_log_error::log_error;
 
 use clap::Parser;
 use jsonwebtoken::jwk::JwkSet;
@@ -452,9 +453,8 @@ fn download_or_compile(
             let _ = shell.warn(format!(
                 "Download failed: {e}.\nI'll try compiling from source instead."
             ));
-            tracing::warn!(
-                error.msg = %e,
-                error.cause = ?e,
+            log_error!(
+                e, level: tracing::Level::WARN,
                 "Failed to download prebuilt `{}` binary. I'll try to build it from source instead.", kind.binary_target_name()
             );
         }

libs/pavex_cli/src/main.rs

@@ -5,6 +5,7 @@ use cargo_like_utils::shell::Shell;
 use guppy::graph::PackageSource;
 use guppy::Version;
 use std::path::{Path, PathBuf};
+use tracing_log_error::log_error;
 
 pub enum InstallSource {
     /// Install the binary from the current workspace.
@@ -169,11 +170,7 @@ pub(super) fn install(
                 let _ = shell.warn(format!(
                     "Download failed: {e}.\nI'll try compiling from source instead."
                 ));
-                tracing::warn!(
-                    error.msg = %e,
-                    error.cause = ?e,
-                    "Failed to download prebuilt `pavexc` binary. I'll try to build it from source instead.",
-                );
+                log_error!(e, level: tracing::Level::WARN, "Failed to download prebuilt `pavexc` binary. I'll try to build it from source instead.");
             }
         }
     }