chore: improve tracing in network monitor

SantiagoPittella · SantiagoPittella · commit 97531ec1ba6e · 2025-11-13T17:32:27.000-03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.12.3 (TBD)
+
+- Improved tracing in `miden-network-monitor` binary ([#1366](https://github.com/0xMiden/miden-node/pull/1366)).
+
 ## v0.12.2 (2025-11-12)
 
 - Fixed `PoW` challenge solving in `miden-network-monitor` binary ([#1363](https://github.com/0xMiden/miden-node/pull/1363)).
diff --git a/bin/network-monitor/src/commands/start.rs b/bin/network-monitor/src/commands/start.rs
@@ -4,7 +4,7 @@
 
 use anyhow::Result;
 use miden_node_utils::logging::OpenTelemetry;
-use tracing::{info, instrument, warn};
+use tracing::{debug, info, instrument, warn};
 
 use crate::COMPONENT;
 use crate::config::MonitorConfig;
@@ -15,7 +15,16 @@ use crate::monitor::tasks::Tasks;
 ///
 /// This function initializes all monitoring tasks including RPC status checking,
 /// remote prover testing, faucet testing, and the web frontend.
-#[instrument(target = COMPONENT, name = "start-monitor", skip_all, fields(port = %config.port))]
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.start_monitor",
+    skip_all,
+    level = "info",
+    fields(port = %config.port),
+    ret(level = "debug"),
+    err
+)]
 pub async fn start_monitor(config: MonitorConfig) -> Result<()> {
     // Load configuration from command-line arguments and environment variables
     info!("Loaded configuration: {:?}", config);
@@ -27,19 +36,24 @@ pub async fn start_monitor(config: MonitorConfig) -> Result<()> {
     };
 
     let mut tasks = Tasks::new();
+    debug!(target: COMPONENT, "Initializing monitoring tasks");
 
     // Initialize the RPC Status endpoint checker task.
+    debug!(target: COMPONENT, "Initializing RPC status checker");
     let rpc_rx = tasks.spawn_rpc_checker(&config).await?;
 
     // Initialize the prover checkers & tests tasks, only if URLs were provided.
     let prover_rxs = if config.remote_prover_urls.is_empty() {
+        debug!(target: COMPONENT, "No remote prover URLs configured, skipping prover tasks");
         Vec::new()
     } else {
+        debug!(target: COMPONENT, "Initializing prover checkers and tests");
         tasks.spawn_prover_tasks(&config).await?
     };
 
     // Initialize the faucet testing task.
     let faucet_rx = if config.faucet_url.is_some() {
+        debug!(target: COMPONENT, "Initializing faucet testing task");
         Some(tasks.spawn_faucet(&config))
     } else {
         warn!("Faucet URL not configured, skipping faucet testing");
@@ -48,12 +62,15 @@ pub async fn start_monitor(config: MonitorConfig) -> Result<()> {
 
     // Initialize the counter increment task only if enabled.
     let ntx_service_rx = if config.disable_ntx_service {
+        debug!(target: COMPONENT, "NTX service disabled, skipping counter increment task");
         None
     } else {
+        debug!(target: COMPONENT, "Initializing counter increment task");
         Some(tasks.spawn_ntx_service(&config).await?)
     };
 
     // Initialize HTTP server.
+    debug!(target: COMPONENT, "Initializing HTTP server");
     let server_state = ServerState {
         rpc: rpc_rx,
         provers: prover_rxs,
diff --git a/bin/network-monitor/src/counter.rs b/bin/network-monitor/src/counter.rs
@@ -241,7 +241,15 @@ async fn setup_counter_increment(
 /// # Returns
 ///
 /// This function runs indefinitely, only returning on error.
-#[instrument(target = COMPONENT, name = "run-ntx-service-task", skip_all, ret(level = "debug"))]
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.counter.run_ntx_service_task",
+    skip_all,
+    level = "info",
+    ret(level = "debug"),
+    err
+)]
 pub async fn run_ntx_service_task(
     config: MonitorConfig,
     tx: watch::Sender<ServiceStatus>,
@@ -388,7 +396,15 @@ fn load_counter_account(file_path: &Path) -> Result<Account> {
 
 /// Create and submit a network note that targets the counter account.
 #[allow(clippy::too_many_arguments)]
-#[instrument(target = COMPONENT, name = "create-and-submit-network-note", skip_all, ret)]
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.counter.create_and_submit_network_note",
+    skip_all,
+    level = "info",
+    ret(level = "debug"),
+    err
+)]
 async fn create_and_submit_network_note(
     wallet_account: &Account,
     counter_account: &Account,
diff --git a/bin/network-monitor/src/faucet.rs b/bin/network-monitor/src/faucet.rs
@@ -75,7 +75,14 @@ struct GetTokensResponse {
 /// # Returns
 ///
 /// `Ok(())` if the task completes successfully, or an error if the task fails.
-#[instrument(target = COMPONENT, name = "faucet-test-task", skip_all)]
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.faucet.run_faucet_test_task",
+    skip_all,
+    level = "info",
+    ret(level = "debug")
+)]
 pub async fn run_faucet_test_task(
     faucet_url: Url,
     status_sender: watch::Sender<ServiceStatus>,
@@ -150,6 +157,15 @@ pub async fn run_faucet_test_task(
 /// # Returns
 ///
 /// The response from the faucet if successful, or an error if the test fails.
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.faucet.perform_faucet_test",
+    skip_all,
+    level = "info",
+    ret(level = "debug"),
+    err
+)]
 async fn perform_faucet_test(
     client: &Client,
     faucet_url: &Url,
@@ -221,7 +237,15 @@ async fn perform_faucet_test(
 ///
 /// The nonce that solves the challenge, or an error if no solution is found within reasonable
 /// bounds.
-#[instrument(target = COMPONENT, name = "solve-pow-challenge", skip_all, ret(level = "debug"))]
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.faucet.solve_pow_challenge",
+    skip_all,
+    level = "info",
+    ret(level = "debug"),
+    err
+)]
 fn solve_pow_challenge(challenge: &str, target: u64) -> anyhow::Result<u64> {
     let challenge_bytes = hex::decode(challenge).context("Failed to decode challenge from hex")?;
 
diff --git a/bin/network-monitor/src/monitor/tasks.rs b/bin/network-monitor/src/monitor/tasks.rs
@@ -42,11 +42,21 @@ impl Tasks {
     }
 
     /// Spawn the RPC status checker task.
-    #[instrument(target = COMPONENT, name = "tasks.spawn-rpc-checker", skip_all)]
+    #[instrument(
+        parent = None,
+        target = COMPONENT,
+        name = "network_monitor.tasks.spawn_rpc_checker",
+        skip_all,
+        level = "info",
+        ret(level = "debug"),
+        err
+    )]
     pub async fn spawn_rpc_checker(
         &mut self,
         config: &MonitorConfig,
     ) -> Result<Receiver<ServiceStatus>> {
+        debug!(target: COMPONENT, rpc_url = %config.rpc_url, "Spawning RPC status checker task");
+
         // Create initial status for RPC service
         let mut rpc = ClientBuilder::new(config.rpc_url.clone())
             .with_tls()
@@ -71,15 +81,25 @@ impl Tasks {
             .id();
         self.names.insert(id, "rpc-checker".to_string());
 
+        debug!(target: COMPONENT, "RPC status checker task spawned successfully");
         Ok(rpc_rx)
     }
 
     /// Spawn prover status and test tasks for all configured provers.
-    #[instrument(target = COMPONENT, name = "tasks.spawn-prover-tasks", skip_all)]
+    #[instrument(
+        parent = None,
+        target = COMPONENT,
+        name = "network_monitor.tasks.spawn_prover_tasks",
+        skip_all,
+        level = "info",
+        ret(level = "debug"),
+        err
+    )]
     pub async fn spawn_prover_tasks(
         &mut self,
         config: &MonitorConfig,
     ) -> Result<Vec<(watch::Receiver<ServiceStatus>, watch::Receiver<ServiceStatus>)>> {
+        debug!(target: COMPONENT, prover_count = config.remote_prover_urls.len(), "Spawning prover tasks");
         let mut prover_rxs = Vec::new();
 
         for (i, prover_url) in config.remote_prover_urls.iter().enumerate() {
@@ -181,11 +201,19 @@ impl Tasks {
             prover_rxs.push((prover_status_rx, prover_test_rx));
         }
 
+        debug!(target: COMPONENT, spawned_provers = prover_rxs.len(), "All prover tasks spawned successfully");
         Ok(prover_rxs)
     }
 
     /// Spawn the faucet testing task.
-    #[instrument(target = COMPONENT, name = "tasks.spawn-faucet", skip_all)]
+    #[instrument(
+        parent = None,
+        target = COMPONENT,
+        name = "network_monitor.tasks.spawn_faucet",
+        skip_all,
+        level = "info",
+        ret(level = "debug")
+    )]
     pub fn spawn_faucet(&mut self, config: &MonitorConfig) -> Receiver<ServiceStatus> {
         let current_time = current_unix_timestamp_secs();
 
@@ -221,7 +249,15 @@ impl Tasks {
     }
 
     /// Spawn the network transaction service checker task.
-    #[instrument(target = COMPONENT, name = "tasks.spawn-ntx-service", skip_all)]
+    #[instrument(
+        parent = None,
+        target = COMPONENT,
+        name = "network_monitor.tasks.spawn_ntx_service",
+        skip_all,
+        level = "info",
+        ret(level = "debug"),
+        err
+    )]
     pub async fn spawn_ntx_service(
         &mut self,
         config: &MonitorConfig,
@@ -265,7 +301,14 @@ impl Tasks {
     }
 
     /// Spawn the HTTP frontend server.
-    #[instrument(target = COMPONENT, name = "tasks.spawn-frontend", skip_all)]
+    #[instrument(
+        parent = None,
+        target = COMPONENT,
+        name = "network_monitor.tasks.spawn_http_server",
+        skip_all,
+        level = "info",
+        ret(level = "debug")
+    )]
     pub fn spawn_http_server(&mut self, server_state: ServerState, config: &MonitorConfig) {
         let config = config.clone();
         let id = self.handles.spawn(async move { serve(server_state, config).await }).id();
diff --git a/bin/network-monitor/src/remote_prover.rs b/bin/network-monitor/src/remote_prover.rs
@@ -87,7 +87,14 @@ pub struct ProverTestDetails {
 /// # Returns
 ///
 /// `Ok(())` if the task completes successfully, or an error if the task fails.
-#[instrument(target = COMPONENT, name = "remote-prover-test-task", skip_all)]
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.remote_prover.run_remote_prover_test_task",
+    skip_all,
+    level = "info",
+    ret(level = "debug")
+)]
 pub async fn run_remote_prover_test_task(
     prover_url: Url,
     name: &str,
@@ -151,7 +158,14 @@ pub async fn run_remote_prover_test_task(
 /// # Returns
 ///
 /// A `ServiceStatus` containing the results of the proof test.
-#[instrument(target = COMPONENT, name = "test-remote-prover", skip_all, ret(level = "info"))]
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.remote_prover.test_remote_prover",
+    skip_all,
+    level = "info",
+    ret(level = "debug")
+)]
 async fn test_remote_prover(
     client: &mut miden_node_proto::clients::RemoteProverClient,
     name: &str,
@@ -254,6 +268,15 @@ fn tonic_status_to_json(status: &tonic::Status) -> String {
 /// This function creates a mock transaction using `MockChainBuilder` similar to what's done
 /// in the remote prover tests. The transaction is generated once and can be reused for
 /// multiple proof test calls.
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.remote_prover.generate_mock_transaction",
+    skip_all,
+    level = "info",
+    ret(level = "debug"),
+    err
+)]
 pub async fn generate_mock_transaction() -> anyhow::Result<TransactionInputs> {
     let mut mock_chain_builder = MockChainBuilder::new();
 
@@ -301,6 +324,14 @@ pub async fn generate_mock_transaction() -> anyhow::Result<TransactionInputs> {
 // GENERATE TEST REQUEST PAYLOAD
 // ================================================================================================
 
+#[instrument(
+    parent = None,
+    target = COMPONENT,
+    name = "network_monitor.remote_prover.generate_prover_test_payload",
+    skip_all,
+    level = "info",
+    ret(level = "debug")
+)]
 pub(crate) async fn generate_prover_test_payload() -> proto::remote_prover::ProofRequest {
     proto::remote_prover::ProofRequest {
         proof_type: proto::remote_prover::ProofType::Transaction.into(),
diff --git a/bin/network-monitor/src/status.rs b/bin/network-monitor/src/status.rs
