node iter seek metrics

shekhirin · shekhirin · commit 389ca28fa569 · 2025-03-19T12:52:51.000Z
diff --git a/crates/trie/parallel/src/proof.rs b/crates/trie/parallel/src/proof.rs
@@ -19,7 +19,7 @@ use reth_provider::{
 use reth_storage_errors::db::DatabaseError;
 use reth_trie::{
     hashed_cursor::{HashedCursorFactory, HashedPostStateCursorFactory},
-    node_iter::{TrieElement, TrieNodeIter},
+    node_iter::{TrieElement, TrieNodeIter, TrieNodeIterType},
     prefix_set::{PrefixSetMut, TriePrefixSetsMut},
     proof::StorageProof,
     trie_cursor::{InMemoryTrieCursorFactory, TrieCursorFactory},
@@ -183,6 +183,7 @@ where
         let mut account_node_iter = TrieNodeIter::new(
             walker,
             hashed_cursor_factory.hashed_account_cursor().map_err(ProviderError::Database)?,
+            TrieNodeIterType::Account,
         );
         while let Some(account_node) =
             account_node_iter.try_next().map_err(ProviderError::Database)?
diff --git a/crates/trie/parallel/src/root.rs b/crates/trie/parallel/src/root.rs
@@ -12,7 +12,7 @@ use reth_provider::{
 use reth_storage_errors::db::DatabaseError;
 use reth_trie::{
     hashed_cursor::{HashedCursorFactory, HashedPostStateCursorFactory},
-    node_iter::{TrieElement, TrieNodeIter},
+    node_iter::{TrieElement, TrieNodeIter, TrieNodeIterType},
     trie_cursor::{InMemoryTrieCursorFactory, TrieCursorFactory},
     updates::TrieUpdates,
     walker::TrieWalker,
@@ -153,6 +153,7 @@ where
         let mut account_node_iter = TrieNodeIter::new(
             walker,
             hashed_cursor_factory.hashed_account_cursor().map_err(ProviderError::Database)?,
+            TrieNodeIterType::Account,
         );
 
         let mut hash_builder = HashBuilder::default().with_updates(retain_updates);
diff --git a/crates/trie/trie/src/node_iter.rs b/crates/trie/trie/src/node_iter.rs
@@ -1,5 +1,7 @@
 use crate::{hashed_cursor::HashedCursor, trie_cursor::TrieCursor, walker::TrieWalker, Nibbles};
 use alloy_primitives::B256;
+use metrics::Counter;
+use reth_metrics::Metrics;
 use reth_storage_errors::db::DatabaseError;
 
 /// Represents a branch node in the trie.
@@ -49,11 +51,13 @@ pub struct TrieNodeIter<C, H: HashedCursor> {
     current_hashed_entry: Option<(B256, <H as HashedCursor>::Value)>,
     /// Flag indicating whether we should check the current walker key.
     current_walker_key_checked: bool,
+
+    metrics: NodeIterMetrics,
 }
 
 impl<C, H: HashedCursor> TrieNodeIter<C, H> {
     /// Creates a new [`TrieNodeIter`].
-    pub const fn new(walker: TrieWalker<C>, hashed_cursor: H) -> Self {
+    pub fn new(walker: TrieWalker<C>, hashed_cursor: H, node_iter_type: TrieNodeIterType) -> Self {
         Self {
             walker,
             hashed_cursor,
@@ -62,6 +66,7 @@ impl<C, H: HashedCursor> TrieNodeIter<C, H> {
             hashed_cursor_next: false,
             current_hashed_entry: None,
             current_walker_key_checked: false,
+            metrics: NodeIterMetrics::new_with_labels(&[("type", node_iter_type.as_str())]),
         }
     }
 
@@ -118,6 +123,8 @@ where
                 } else {
                     self.current_hashed_entry = entry;
                 }
+
+                self.metrics.hashed_cursor_seeks.increment(1);
             }
 
             // If there's a hashed entry...
@@ -158,3 +165,28 @@ where
         Ok(None)
     }
 }
+
+/// The type of the node iter.
+#[derive(Debug)]
+pub enum TrieNodeIterType {
+    /// The node iter for the account trie.
+    Account,
+    /// The node iter for the storage trie.
+    Storage,
+}
+
+impl TrieNodeIterType {
+    fn as_str(&self) -> &'static str {
+        match self {
+            Self::Account => "account",
+            Self::Storage => "storage",
+        }
+    }
+}
+
+#[derive(Metrics)]
+#[metrics(scope = "trie.node_iter")]
+struct NodeIterMetrics {
+    /// The number of times the hashed cursor was seeked.
+    pub hashed_cursor_seeks: Counter,
+}
diff --git a/crates/trie/trie/src/proof/mod.rs b/crates/trie/trie/src/proof/mod.rs
@@ -1,6 +1,6 @@
 use crate::{
     hashed_cursor::{HashedCursorFactory, HashedStorageCursor},
-    node_iter::{TrieElement, TrieNodeIter},
+    node_iter::{TrieElement, TrieNodeIter, TrieNodeIterType},
     prefix_set::{PrefixSetMut, TriePrefixSetsMut},
     trie_cursor::TrieCursorFactory,
     walker::TrieWalker,
@@ -124,7 +124,8 @@ where
         let mut storages: B256Map<_> =
             targets.keys().map(|key| (*key, StorageMultiProof::empty())).collect();
         let mut account_rlp = Vec::with_capacity(TRIE_ACCOUNT_RLP_MAX_SIZE);
-        let mut account_node_iter = TrieNodeIter::new(walker, hashed_account_cursor);
+        let mut account_node_iter =
+            TrieNodeIter::new(walker, hashed_account_cursor, TrieNodeIterType::Account);
         while let Some(account_node) = account_node_iter.try_next()? {
             match account_node {
                 TrieElement::Branch(node) => {
@@ -288,7 +289,8 @@ where
         let mut hash_builder = HashBuilder::default()
             .with_proof_retainer(retainer)
             .with_updates(self.collect_branch_node_masks);
-        let mut storage_node_iter = TrieNodeIter::new(walker, hashed_storage_cursor);
+        let mut storage_node_iter =
+            TrieNodeIter::new(walker, hashed_storage_cursor, TrieNodeIterType::Storage);
         while let Some(node) = storage_node_iter.try_next()? {
             match node {
                 TrieElement::Branch(node) => {
diff --git a/crates/trie/trie/src/trie.rs b/crates/trie/trie/src/trie.rs
@@ -1,6 +1,6 @@
 use crate::{
     hashed_cursor::{HashedCursorFactory, HashedStorageCursor},
-    node_iter::{TrieElement, TrieNodeIter},
+    node_iter::{TrieElement, TrieNodeIter, TrieNodeIterType},
     prefix_set::{PrefixSet, TriePrefixSets},
     progress::{IntermediateStateRootState, StateRootProgress},
     stats::TrieTracker,
@@ -165,15 +165,17 @@ where
                     self.prefix_sets.account_prefix_set,
                 )
                 .with_deletions_retained(retain_updates);
-                let node_iter = TrieNodeIter::new(walker, hashed_account_cursor)
-                    .with_last_hashed_key(state.last_account_key);
+                let node_iter =
+                    TrieNodeIter::new(walker, hashed_account_cursor, TrieNodeIterType::Account)
+                        .with_last_hashed_key(state.last_account_key);
                 (hash_builder, node_iter)
             }
             None => {
                 let hash_builder = HashBuilder::default().with_updates(retain_updates);
                 let walker = TrieWalker::new(trie_cursor, self.prefix_sets.account_prefix_set)
                     .with_deletions_retained(retain_updates);
-                let node_iter = TrieNodeIter::new(walker, hashed_account_cursor);
+                let node_iter =
+                    TrieNodeIter::new(walker, hashed_account_cursor, TrieNodeIterType::Account);
                 (hash_builder, node_iter)
             }
         };
@@ -412,7 +414,8 @@ where
 
         let mut hash_builder = HashBuilder::default().with_updates(retain_updates);
 
-        let mut storage_node_iter = TrieNodeIter::new(walker, hashed_storage_cursor);
+        let mut storage_node_iter =
+            TrieNodeIter::new(walker, hashed_storage_cursor, TrieNodeIterType::Storage);
         while let Some(node) = storage_node_iter.try_next()? {
             match node {
                 TrieElement::Branch(node) => {
