fatxpool: use tracing for logging (#6897)

This PR modifies the fatxpool to use tracing instead of log for logging.

closes #5490

Polkadot address: 12GyGD3QhT4i2JJpNzvMf96sxxBLWymz4RdGCxRH5Rj5agKW

---------

Co-authored-by: Michal Kucharczyk <[email protected]>

Author: dharjeezy

Cargo.lock

@@ -0,0 +1,7 @@
+title: 'Tracing Log for fork-aware transaction pool'
+doc:
+- audience: Node Dev
+  description: Replacement of log crate with tracing crate for better logging.
+crates:
+- name: sc-transaction-pool
+  bump: minor

prdoc/pr_6897.prdoc

@@ -40,6 +40,7 @@ sp-transaction-pool = { workspace = true, default-features = true }
 thiserror = { workspace = true }
 tokio = { workspace = true, default-features = true, features = ["macros", "time"] }
 tokio-stream = { workspace = true }
+tracing = { workspace = true, default-features = true }
 
 [dev-dependencies]
 array-bytes = { workspace = true, default-features = true }

substrate/client/transaction-pool/Cargo.toml

@@ -25,6 +25,7 @@ pub(crate) mod log_xt;
 pub(crate) mod metrics;
 #[cfg(test)]
 pub(crate) mod tests;
+pub(crate) mod tracing_log_xt;
 
 use futures::StreamExt;
 use std::sync::Arc;

substrate/client/transaction-pool/src/common/mod.rs

@@ -0,0 +1,69 @@
+// This file is part of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+//! Utility for logging transaction collections with tracing crate.
+
+/// Logs every transaction from given `tx_collection` with given level.
+macro_rules! log_xt {
+    (data: hash, target: $target:expr, $level:expr, $tx_collection:expr, $text_with_format:expr) => {
+        for tx in $tx_collection {
+            tracing::event!(
+                $level,
+                target = $target,
+                tx_hash = format!("{:?}", tx),
+                $text_with_format,
+            );
+        }
+    };
+    (data: hash, target: $target:expr, $level:expr, $tx_collection:expr, $text_with_format:expr, $($arg:expr),*) => {
+        for tx in $tx_collection {
+            tracing::event!(
+                $level,
+                target = $target,
+                tx_hash = format!("{:?}", tx),
+                $text_with_format,
+                $($arg),*
+            );
+        }
+    };
+    (data: tuple, target: $target:expr, $level:expr, $tx_collection:expr, $text_with_format:expr) => {
+        for tx in $tx_collection {
+            tracing::event!(
+                $level,
+                target = $target,
+                tx_hash = format!("{:?}", tx.0),
+                $text_with_format,
+                tx.1
+            );
+        }
+    };
+}
+macro_rules! log_xt_trace {
+    (data: $datatype:ident, target: $target:expr, $($arg:tt)+) => {
+        $crate::common::tracing_log_xt::log_xt!(data: $datatype, target: $target, tracing::Level::TRACE, $($arg)+);
+    };
+    (target: $target:expr, $tx_collection:expr, $text_with_format:expr) => {
+        $crate::common::tracing_log_xt::log_xt!(data: hash, target: $target, tracing::Level::TRACE, $tx_collection, $text_with_format);
+    };
+    (target: $target:expr, $tx_collection:expr, $text_with_format:expr, $($arg:expr)*) => {
+        $crate::common::tracing_log_xt::log_xt!(data: hash, target: $target, tracing::Level::TRACE, $tx_collection, $text_with_format, $($arg)*);
+    };
+}
+
+pub(crate) use log_xt;
+pub(crate) use log_xt_trace;

substrate/client/transaction-pool/src/common/tracing_log_xt.rs

@@ -22,13 +22,12 @@
 //! by any view are detected and properly notified.
 
 use crate::{
-	common::log_xt::log_xt_trace,
+	common::tracing_log_xt::log_xt_trace,
 	fork_aware_txpool::stream_map_util::next_event,
 	graph::{self, BlockHash, ExtrinsicHash},
 	LOG_TARGET,
 };
 use futures::stream::StreamExt;
-use log::{debug, trace};
 use sc_transaction_pool_api::TransactionStatus;
 use sc_utils::mpsc;
 use sp_runtime::traits::Block as BlockT;
@@ -41,6 +40,7 @@ use std::{
 	pin::Pin,
 };
 use tokio_stream::StreamMap;
+use tracing::{debug, trace};
 
 /// Represents a transaction that was removed from the transaction pool, including the reason of its
 /// removal.
@@ -225,7 +225,7 @@ where
 				log_xt_trace!(
 					target: LOG_TARGET,
 					xts.clone(),
-					"[{:?}] dropped_watcher: finalized xt removed"
+					"dropped_watcher: finalized xt removed"
 				);
 				xts.iter().for_each(|xt| {
 					self.ready_transaction_views.remove(xt);
@@ -279,7 +279,7 @@ where
 						return Some(DroppedTransaction::new_enforced_by_limts(tx_hash))
 					}
 				} else {
-					debug!("[{:?}] dropped_watcher: removing (non-tracked) tx", tx_hash);
+					debug!(target: LOG_TARGET, ?tx_hash, "dropped_watcher: removing (non-tracked) tx");
 					return Some(DroppedTransaction::new_enforced_by_limts(tx_hash))
 				}
 			},