Improve logging for Tendermint State Update

nimiq · Nov 26, 2024 · cea095c · cea095c
1 parent 40fb803
commit cea095c
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 4 deletions.
diff --git a/validator/src/aggregation/tendermint/contribution.rs b/validator/src/aggregation/tendermint/contribution.rs
@@ -25,6 +25,19 @@ impl std::fmt::Debug for TendermintContribution {
     }
 }
 
+impl std::fmt::Display for TendermintContribution {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+        let mut debug = f.debug_map();
+        // Use short string for hashes.
+        debug.entries(
+            self.contributions
+                .iter()
+                .map(|(v, m)| (v.as_ref().map(|hash| hash.to_short_str()), &m.signers)),
+        );
+        debug.finish()
+    }
+}
+
 impl TendermintContribution {
     pub(crate) fn from_vote(
         vote: TendermintVote,

diff --git a/validator/src/aggregation/tendermint/state.rs b/validator/src/aggregation/tendermint/state.rs
@@ -1,4 +1,7 @@
-use std::{collections::BTreeMap, fmt::Debug};
+use std::{
+    collections::BTreeMap,
+    fmt::{Debug, Display},
+};
 
 use nimiq_block::{MacroBody, MacroHeader};
 use nimiq_database_value_derive::DbSerializable;
@@ -35,13 +38,50 @@ impl Debug for MacroState {
         dbg.field("step", &self.step);
         dbg.field("locked", &self.locked);
         dbg.field("valid", &self.valid);
-        dbg.field("best_votes", &self.best_votes);
-        dbg.field("votes", &self.votes);
+        // Wrap the following fields to clean up the debug representation.
+        dbg.field("best_votes", &BestVotes(&self.best_votes));
+        dbg.field("votes", &Votes(&self.votes));
 
         dbg.finish()
     }
 }
 
+/// A simple wrapper to use `Display` instead of `Debug`.
+struct DisplayWrapper<'a, T>(&'a T);
+impl<'a, T> Debug for DisplayWrapper<'a, T>
+where
+    T: Display,
+{
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        // Use Display instead.
+        Display::fmt(&self.0, f)
+    }
+}
+
+struct BestVotes<'a>(&'a BTreeMap<(u32, Step), TendermintContribution>);
+impl<'a> Debug for BestVotes<'a> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        // Use the `Display` implementation for `TendermintContribution` instead.
+        f.debug_map()
+            .entries(self.0.iter().map(|(k, v)| (k, DisplayWrapper(v))))
+            .finish()
+    }
+}
+
+struct Votes<'a>(&'a BTreeMap<(u32, Step), Option<Blake2sHash>>);
+impl<'a> Debug for Votes<'a> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        // Use short representations for the hashes instead.
+        f.debug_map()
+            .entries(
+                self.0
+                    .iter()
+                    .map(|(k, v)| (k, v.as_ref().map(|hash| hash.to_short_str()))),
+            )
+            .finish()
+    }
+}
+
 impl MacroState {
     pub fn from_tendermint_state<TValidatorNetwork>(
         block_number: u32,

diff --git a/validator/src/validator.rs b/validator/src/validator.rs
@@ -603,7 +603,7 @@ where
                 // In case of a new state update we need to store the new version of it disregarding
                 // any old state which potentially still lingers.
                 MappedReturn::Update(update) => {
-                    trace!(?update, "Tendermint state update");
+                    debug!(?update, "Tendermint state update");
 
                     let expected_block_number = self.blockchain.read().block_number() + 1;
                     if expected_block_number != update.block_number {