[Profiling] Adding spawn_named! macro to name tasks when aptos-console enabled

Author: Markuze

consensus/src/epoch_manager.rs

@@ -415,7 +415,7 @@ impl EpochManager {
             self.quorum_store_to_mempool_sender.clone(),
             self.config.mempool_txn_pull_timeout_ms,
         );
-        tokio::spawn(quorum_store.start());
+        spawn_named!("Quorum Store", quorum_store.start());
     }
 
     /// this function spawns the phases and a buffer manager

consensus/src/experimental/buffer_manager.rs

@@ -162,7 +162,7 @@ impl BufferManager {
         duration: Duration,
     ) {
         counters::BUFFER_MANAGER_RETRY_COUNT.inc();
-        tokio::spawn(async move {
+        spawn_named!(&format!("retry request")[..], async move {
             tokio::time::sleep(duration).await;
             sender
                 .send(request)

crates/aptos-logger/src/lib.rs

@@ -139,7 +139,7 @@ pub mod prelude {
         debug, error, info, sample,
         sample::{SampleRate, Sampling},
         security::SecurityEvent,
-        trace, warn,
+        spawn_named, trace, warn,
     };
 }
 

crates/aptos-logger/src/macros.rs

@@ -2,6 +2,44 @@
 // SPDX-License-Identifier: Apache-2.0
 
 //! Macros for sending logs at predetermined log `Level`s
+#[cfg(not(feature = "aptos-console"))]
+#[macro_export]
+macro_rules! spawn_named {
+      ($name:expr, $func:expr) => { tokio::spawn($func); };
+      ($name:expr, $handler:expr, $func:expr) => { $handler.spawn($func); };
+      ($name:expr, $async:ident = async; $clojure:block) => { tokio::spawn( async $clojure); };
+      ($name:expr, $handler:expr, $async:ident = async; $clojure:block) => { $handler.spawn( async $clojure); };
+      ($name:expr, $async:ident = async ; $move:ident = move; $clojure:block) => { tokio::spawn( async move $clojure); };
+      ($name:expr, $handler:expr, $async:ident = async ; $move:ident = move; $clojure:block) => { $handler.spawn( async move $clojure); };
+  }
+
+#[cfg(feature = "aptos-console")]
+#[macro_export]
+macro_rules! spawn_named {
+      ($name:expr, $func:expr) => { tokio::task::Builder::new()
+                                          .name($name)
+                                          .spawn($func); };
+      ($name:expr, $handle:expr, $func:expr) => { tokio::task::Builder::new()
+                                                      .name($name)
+                                                      .spawn_on($func, $handle); };
+
+      ($name:expr, $async:ident = async; $clojure:block) => { tokio::task::Builder::new()
+                                                                      .name($name)
+                                                                      .spawn(async $clojure); };
+
+      ($name:expr, $async:ident = async; $move:ident = move; $clojure:block) => { tokio::task::Builder::new()
+                                                                      .name($name)
+                                                                      .spawn(async move $clojure); };
+
+      ($name:expr, $handler:expr, $async:ident = async; $clojure:block) => { tokio::task::Builder::new()
+                                                                              .name($name)
+                                                                              .spawn_on(async $clojure, $handler); };
+
+      ($name:expr, $handler:expr, $async:ident = async; $move:ident = move; $clojure:block) => { tokio::task::Builder::new()
+                                                                                                  .name($name)
+                                                                                                  .spawn_on(async move $clojure, $handler); };
+
+}
 
 /// Log at the given level, it's recommended to use a specific level macro instead
 #[macro_export]

network/discovery/src/file.rs

@@ -12,6 +12,9 @@ use std::{
     time::Duration,
 };
 
+#[cfg(test)]
+use aptos_logger::spawn_named;
+
 pub struct FileStream {
     file_path: PathBuf,
     interval: Pin<Box<Interval>>,
@@ -83,7 +86,7 @@ mod tests {
             Box::pin(listener).run().await
         };
 
-        tokio::task::spawn(listener_task);
+        spawn_named!("[Network] Listner Task", listener_task);
         conn_mgr_reqs_rx
     }
 
@@ -154,7 +157,7 @@ mod tests {
             let peers: PeerSet = PeerSet::new();
             write_peer_set(&peers, path.as_ref().as_ref());
         };
-        tokio::task::spawn(writer_task);
+        spawn_named!("[Network] Writer Task", writer_task);
 
         if let Some(ConnectivityRequest::UpdateDiscoveredPeers(
             DiscoverySource::File,

network/discovery/src/lib.rs

@@ -96,7 +96,7 @@ impl DiscoveryChangeListener {
     }
 
     pub fn start(self, executor: &Handle) {
-        executor.spawn(Box::pin(self).run());
+        spawn_named!("DiscoveryChangeListener", executor, Box::pin(self).run());
     }
 
     async fn run(mut self: Pin<Box<Self>>) {

network/src/protocols/health_checker/builder.rs

@@ -9,6 +9,7 @@ use crate::{
     },
 };
 use aptos_config::network_id::NetworkContext;
+use aptos_logger::prelude::*;
 use aptos_time_service::TimeService;
 use std::{sync::Arc, time::Duration};
 use tokio::runtime::Handle;
@@ -43,7 +44,7 @@ impl HealthCheckerBuilder {
 
     pub fn start(&mut self, executor: &Handle) {
         if let Some(service) = self.service.take() {
-            executor.spawn(service.start());
+            spawn_named!("[Network] HC", executor, service.start());
         }
     }
 }