feat(consensus): add tracing instrumentation and logging to consensus

crates/papyrus_node/src/main.rs

@@ -46,7 +46,7 @@ use starknet_client::reader::PendingData;
 use tokio::sync::RwLock;
 use tokio::task::{JoinError, JoinHandle};
 use tracing::metadata::LevelFilter;
-use tracing::{debug_span, error, info, warn, Instrument};
+use tracing::{debug, debug_span, error, info, warn, Instrument};
 use tracing_subscriber::prelude::*;
 use tracing_subscriber::{fmt, EnvFilter};
 
@@ -98,7 +98,7 @@ fn run_consensus(
     consensus_channels: BroadcastSubscriberChannels<ConsensusMessage>,
 ) -> anyhow::Result<JoinHandle<Result<(), ConsensusError>>> {
     let Ok(validator_id) = env::var("CONSENSUS_VALIDATOR_ID") else {
-        info!("CONSENSUS_VALIDATOR_ID is not set. Not run consensus.");
+        debug!("CONSENSUS_VALIDATOR_ID is not set. Not run consensus.");
         return Ok(tokio::spawn(pending()));
     };
     info!("Running consensus as validator {validator_id}");

crates/sequencing/papyrus_consensus/src/lib.rs

@@ -5,7 +5,7 @@ use papyrus_network::network_manager::SubscriberReceiver;
 use papyrus_protobuf::consensus::{ConsensusMessage, Proposal};
 use single_height_consensus::SingleHeightConsensus;
 use starknet_api::block::{BlockHash, BlockNumber};
-use tracing::info;
+use tracing::{debug, info, instrument};
 use types::{ConsensusBlock, ConsensusContext, ConsensusError, ProposalInit, ValidatorId};
 
 // TODO(matan): Remove dead code allowance at the end of milestone 1.
@@ -20,6 +20,10 @@ pub mod types;
 use futures::StreamExt;
 
 // TODO(dvir): add test for this.
+#[instrument(
+    skip(context, start_height, network_receiver),
+    fields(validator_id = %validator_id)
+)]
 pub async fn run_consensus<BlockT: ConsensusBlock>(
     context: Arc<dyn ConsensusContext<Block = BlockT>>,
     start_height: BlockNumber,
@@ -32,12 +36,11 @@ where
 {
     let mut current_height = start_height;
     loop {
-        info!("Starting consensus for height {current_height}");
+        debug!("Starting consensus for height {current_height}");
         let mut shc =
             SingleHeightConsensus::new(current_height, context.clone(), validator_id).await;
 
         let block = if let Some(block) = shc.start().await? {
-            info!("Proposer flow height {current_height}");
             block
         } else {
             info!("Validator flow height {current_height}");

crates/sequencing/papyrus_consensus/src/single_height_consensus.rs

@@ -6,6 +6,7 @@ use std::sync::Arc;
 
 use futures::channel::{mpsc, oneshot};
 use starknet_api::block::{BlockHash, BlockNumber};
+use tracing::{debug, info, instrument};
 
 use crate::types::{ConsensusBlock, ConsensusContext, ConsensusError, ProposalInit, ValidatorId};
 
@@ -36,11 +37,18 @@ where
         Self { height, context, validators, id }
     }
 
+    #[instrument(skip(self), fields(height=self.height.0), level = "info")]
     pub(crate) async fn start(&mut self) -> Result<Option<BlockT>, ConsensusError> {
+        info!(
+            "Starting consensus with validators {:?}",
+            self.validators.iter().map(|id| format!("{}", id)).collect::<Vec<_>>()
+        );
+
         let proposer_id = self.context.proposer(&self.validators, self.height);
         if proposer_id != self.id {
             return Ok(None);
         }
+        debug!("Proposer flow");
 
         let (content_receiver, block_receiver) = self.context.build_proposal(self.height).await;
         let (fin_sender, fin_receiver) = oneshot::channel();
@@ -62,12 +70,18 @@ where
 
     /// Receive a proposal from a peer node. Returns only once the proposal has been fully received
     /// and processed.
+    #[instrument(
+        skip(self, init, content_receiver, fin_receiver),
+        fields(height = %self.height),
+        level = "info"
+    )]
     pub(crate) async fn handle_proposal(
         &mut self,
         init: ProposalInit,
         content_receiver: mpsc::Receiver<<BlockT as ConsensusBlock>::ProposalChunk>,
         fin_receiver: oneshot::Receiver<BlockHash>,
     ) -> Result<Option<BlockT>, ConsensusError> {
+        debug!("Received proposal: proposal_height={}, proposer={}", init.height.0, init.proposer);
         let proposer_id = self.context.proposer(&self.validators, self.height);
         if init.height != self.height {
             let msg = format!("invalid height: expected {:?}, got {:?}", self.height, init.height);