feat(papyrus_network): add broadcast and sqmr metrics structs

starkware-libs · Feb 9, 2025 · 9daba93 · 9daba93
1 parent af983bb
commit 9daba93
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 3 deletions.
diff --git a/crates/papyrus_network/src/network_manager/network_manager_metrics.rs b/crates/papyrus_network/src/network_manager/network_manager_metrics.rs
@@ -1,8 +1,29 @@
-use starknet_sequencer_metrics::metrics::MetricGauge;
+use starknet_sequencer_metrics::metrics::{MetricCounter, MetricGauge};
+
+pub struct BroadcastNetworkMetrics {
+    pub num_sent_broadcast_messages: MetricCounter,
+    pub num_received_broadcast_messages: MetricCounter,
+}
+
+impl BroadcastNetworkMetrics {
+    pub fn register(&self) {
+        self.num_sent_broadcast_messages.register();
+        self.num_received_broadcast_messages.register();
+    }
+}
+
+pub struct SqmrNetworkMetrics {}
+
+impl SqmrNetworkMetrics {
+    pub fn register(&self) {}
+}
+
 pub struct NetworkManagerMetrics {
     pub num_connected_peers: MetricGauge,
     pub num_active_inbound_sessions: MetricGauge,
     pub num_active_outbound_sessions: MetricGauge,
+    pub broadcast_metrics: Option<BroadcastNetworkMetrics>,
+    pub sqmr_metrics: Option<SqmrNetworkMetrics>,
 }
 
 impl NetworkManagerMetrics {
@@ -13,5 +34,11 @@ impl NetworkManagerMetrics {
         num_active_inbound_sessions_metric.set(0f64);
         let num_active_outbound_sessions_metric = self.num_active_outbound_sessions.register();
         num_active_outbound_sessions_metric.set(0f64);
+        if let Some(broadcast_metrics) = self.broadcast_metrics.as_ref() {
+            broadcast_metrics.register();
+        }
+        if let Some(sqmr_metrics) = self.sqmr_metrics.as_ref() {
+            sqmr_metrics.register();
+        }
     }
 }
diff --git a/crates/starknet_consensus_manager/src/consensus_manager.rs b/crates/starknet_consensus_manager/src/consensus_manager.rs
@@ -6,7 +6,10 @@ use std::sync::Arc;
 
 use async_trait::async_trait;
 use papyrus_network::gossipsub_impl::Topic;
-use papyrus_network::network_manager::network_manager_metrics::NetworkManagerMetrics;
+use papyrus_network::network_manager::network_manager_metrics::{
+    BroadcastNetworkMetrics,
+    NetworkManagerMetrics,
+};
 use papyrus_network::network_manager::{BroadcastTopicChannels, NetworkManager};
 use papyrus_protobuf::consensus::{HeightAndRound, ProposalPart, StreamMessage, Vote};
 use starknet_api::block::BlockNumber;
@@ -24,6 +27,8 @@ use starknet_sequencer_metrics::metric_definitions::{
     CONSENSUS_NUM_ACTIVE_INBOUND_SESSIONS,
     CONSENSUS_NUM_ACTIVE_OUTBOUND_SESSIONS,
     CONSENSUS_NUM_CONNECTED_PEERS,
+    CONSENSUS_NUM_RECEIVED_MESSAGES,
+    CONSENSUS_NUM_SENT_MESSAGES,
 };
 use starknet_state_sync_types::communication::SharedStateSyncClient;
 use tracing::{error, info};
@@ -60,6 +65,11 @@ impl ConsensusManager {
             num_connected_peers: CONSENSUS_NUM_CONNECTED_PEERS,
             num_active_inbound_sessions: CONSENSUS_NUM_ACTIVE_INBOUND_SESSIONS,
             num_active_outbound_sessions: CONSENSUS_NUM_ACTIVE_OUTBOUND_SESSIONS,
+            broadcast_metrics: Some(BroadcastNetworkMetrics {
+                num_sent_broadcast_messages: CONSENSUS_NUM_SENT_MESSAGES,
+                num_received_broadcast_messages: CONSENSUS_NUM_RECEIVED_MESSAGES,
+            }),
+            sqmr_metrics: None,
         });
         let mut network_manager =
             NetworkManager::new(self.config.network_config.clone(), None, network_manager_metrics);

diff --git a/crates/starknet_mempool_p2p/src/lib.rs b/crates/starknet_mempool_p2p/src/lib.rs
@@ -4,7 +4,10 @@ pub mod runner;
 
 use futures::FutureExt;
 use papyrus_network::gossipsub_impl::Topic;
-use papyrus_network::network_manager::network_manager_metrics::NetworkManagerMetrics;
+use papyrus_network::network_manager::network_manager_metrics::{
+    BroadcastNetworkMetrics,
+    NetworkManagerMetrics,
+};
 use papyrus_network::network_manager::{BroadcastTopicChannels, NetworkManager};
 use starknet_class_manager_types::transaction_converter::TransactionConverter;
 use starknet_class_manager_types::SharedClassManagerClient;
@@ -13,6 +16,8 @@ use starknet_sequencer_metrics::metric_definitions::{
     MEMPOOL_NUM_ACTIVE_INBOUND_SESSIONS,
     MEMPOOL_NUM_ACTIVE_OUTBOUND_SESSIONS,
     MEMPOOL_NUM_CONNECTED_PEERS,
+    MEMPOOL_NUM_RECEIVED_MESSAGES,
+    MEMPOOL_NUM_SENT_MESSAGES,
 };
 
 use crate::config::MempoolP2pConfig;
@@ -34,6 +39,11 @@ pub fn create_p2p_propagator_and_runner(
         num_connected_peers: MEMPOOL_NUM_CONNECTED_PEERS,
         num_active_inbound_sessions: MEMPOOL_NUM_ACTIVE_INBOUND_SESSIONS,
         num_active_outbound_sessions: MEMPOOL_NUM_ACTIVE_OUTBOUND_SESSIONS,
+        broadcast_metrics: Some(BroadcastNetworkMetrics {
+            num_sent_broadcast_messages: MEMPOOL_NUM_SENT_MESSAGES,
+            num_received_broadcast_messages: MEMPOOL_NUM_RECEIVED_MESSAGES,
+        }),
+        sqmr_metrics: None,
     });
     let mut network_manager = NetworkManager::new(
         mempool_p2p_config.network_config,

diff --git a/crates/starknet_sequencer_metrics/src/metric_definitions.rs b/crates/starknet_sequencer_metrics/src/metric_definitions.rs
@@ -104,4 +104,10 @@ define_counter_metrics!(
         { ADDED_TRANSACTIONS_SUCCESS, "ADDED_TRANSACTIONS_SUCCESS", "Number of successfully added transactions", 0 },
         { ADDED_TRANSACTIONS_FAILURE, "ADDED_TRANSACTIONS_FAILURE", "Number of faulty added transactions", 0 }
     },
+    MetricScope::Network => {
+        { MEMPOOL_NUM_SENT_MESSAGES, "apollo_mempool_num_sent_messages", "The number of messages sent by the mempool p2p component", 0 },
+        { MEMPOOL_NUM_RECEIVED_MESSAGES, "apollo_mempool_num_received_messages", "The number of messages received by the mempool p2p component", 0 },
+        { CONSENSUS_NUM_SENT_MESSAGES, "apollo_consensus_num_sent_messages", "The number of messages sent by the consensus p2p component", 0 },
+        { CONSENSUS_NUM_RECEIVED_MESSAGES, "apollo_consensus_num_received_messages", "The number of messages received by the consensus p2p component", 0 },
+    }
 );
diff --git a/crates/starknet_state_sync/src/runner/mod.rs b/crates/starknet_state_sync/src/runner/mod.rs
@@ -99,6 +99,9 @@ impl StateSyncRunner {
             num_connected_peers: STATE_SYNC_NUM_CONNECTED_PEERS,
             num_active_inbound_sessions: STATE_SYNC_NUM_ACTIVE_INBOUND_SESSIONS,
             num_active_outbound_sessions: STATE_SYNC_NUM_ACTIVE_OUTBOUND_SESSIONS,
+            broadcast_metrics: None,
+            // TODO(alonl): Add metrics for SQMR.
+            sqmr_metrics: None,
         });
         let mut network_manager = network_manager::NetworkManager::new(
             network_config,