From 719a48ad9e7521a8671930a0bdc1f54155bbfad1 Mon Sep 17 00:00:00 2001
From: Henry de Valence <hdevalence@hdevalence.ca>
Date: Fri, 20 Nov 2020 19:58:39 -0800
Subject: [PATCH] state: shorten tracing messages

Make tracing messages more concise by omitting information already
contained in a parent span and by shortening messages.  This makes them
easier to read.
---
 .../src/service/non_finalized_state/chain.rs       |  4 +---
 .../service/non_finalized_state/queued_blocks.rs   | 14 +++++++++-----
 2 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/zebra-state/src/service/non_finalized_state/chain.rs b/zebra-state/src/service/non_finalized_state/chain.rs
index 82b85bff..f3e61a87 100644
--- a/zebra-state/src/service/non_finalized_state/chain.rs
+++ b/zebra-state/src/service/non_finalized_state/chain.rs
@@ -35,12 +35,10 @@ impl Chain {
         let block_height = block
             .coinbase_height()
             .expect("valid non-finalized blocks have a coinbase height");
-
-        trace!(?block_height, "Pushing new block into chain state");
-
         // update cumulative data members
         self.update_chain_state_with(&block);
         self.blocks.insert(block_height, block);
+        trace!("pushed block onto chain");
     }
 
     /// Remove the lowest height block of the non-finalized portion of a chain.
diff --git a/zebra-state/src/service/non_finalized_state/queued_blocks.rs b/zebra-state/src/service/non_finalized_state/queued_blocks.rs
index ec16d807..783ddeb0 100644
--- a/zebra-state/src/service/non_finalized_state/queued_blocks.rs
+++ b/zebra-state/src/service/non_finalized_state/queued_blocks.rs
@@ -48,17 +48,17 @@ impl QueuedBlocks {
             .insert(new_hash);
         assert!(inserted, "hashes must be unique");
 
-        tracing::trace!(num_blocks = %self.blocks.len(), %parent_hash, ?new_height,  "Finished queueing a new block");
+        tracing::trace!(%parent_hash, queued = %self.blocks.len(), "queued block");
         self.update_metrics();
     }
 
     /// Dequeue and return all blocks that were waiting for the arrival of
     /// `parent`.
-    #[instrument(skip(self))]
-    pub fn dequeue_children(&mut self, parent: block::Hash) -> Vec<QueuedBlock> {
+    #[instrument(skip(self), fields(%parent_hash))]
+    pub fn dequeue_children(&mut self, parent_hash: block::Hash) -> Vec<QueuedBlock> {
         let queued_children = self
             .by_parent
-            .remove(&parent)
+            .remove(&parent_hash)
             .unwrap_or_default()
             .into_iter()
             .map(|hash| {
@@ -73,7 +73,11 @@ impl QueuedBlocks {
             self.by_height.remove(&height);
         }
 
-        tracing::trace!(num_blocks = %self.blocks.len(), "Finished dequeuing blocks waiting for parent hash",);
+        tracing::trace!(
+            dequeued = queued_children.len(),
+            remaining = self.blocks.len(),
+            "dequeued blocks"
+        );
         self.update_metrics();
 
         queued_children