From b2841b07da447e9912aa0c013cb94a770544a1c9 Mon Sep 17 00:00:00 2001
From: Pawan Dhananjay <pawandhananjay@gmail.com>
Date: Mon, 27 Jan 2025 17:43:15 -0800
Subject: [PATCH] Record duplicate source metrics

---
 .../gossipsub/src/behaviour.rs                | 24 ++++++++++++++
 .../gossipsub/src/gossip_promises.rs          |  7 ++++
 .../gossipsub/src/metrics.rs                  | 32 +++++++++++++++++++
 3 files changed, 63 insertions(+)

diff --git a/beacon_node/lighthouse_network/gossipsub/src/behaviour.rs b/beacon_node/lighthouse_network/gossipsub/src/behaviour.rs
index 6528e737a33..7eb35cc49bc 100644
--- a/beacon_node/lighthouse_network/gossipsub/src/behaviour.rs
+++ b/beacon_node/lighthouse_network/gossipsub/src/behaviour.rs
@@ -1841,6 +1841,30 @@ where
                 peer_score.duplicated_message(propagation_source, &msg_id, &message.topic);
             }
             self.mcache.observe_duplicate(&msg_id, propagation_source);
+            // track metrics for the source of the duplicates
+            if let Some(metrics) = self.metrics.as_mut() {
+                if self
+                    .mesh
+                    .get(&message.topic)
+                    .is_some_and(|peers| peers.contains(propagation_source))
+                {
+                    // duplicate was received from a mesh peer
+                    metrics.mesh_duplicates(&message.topic);
+                } else if self
+                    .gossip_promises
+                    .contains_peer(&msg_id, propagation_source)
+                {
+                    // duplicate was received from an iwant request
+                    metrics.iwant_duplicates(&message.topic);
+                } else {
+                    tracing::warn!(
+                        messsage=%msg_id,
+                        peer=%propagation_source,
+                        topic=%message.topic,
+                        "Peer should not have sent message"
+                    );
+                }
+            }
             return;
         }
 
diff --git a/beacon_node/lighthouse_network/gossipsub/src/gossip_promises.rs b/beacon_node/lighthouse_network/gossipsub/src/gossip_promises.rs
index 3f72709245f..ce1dee2a72c 100644
--- a/beacon_node/lighthouse_network/gossipsub/src/gossip_promises.rs
+++ b/beacon_node/lighthouse_network/gossipsub/src/gossip_promises.rs
@@ -41,6 +41,13 @@ impl GossipPromises {
         self.promises.contains_key(message)
     }
 
+    /// Returns true if the message id exists in the promises and contains the given peer.
+    pub(crate) fn contains_peer(&self, message: &MessageId, peer: &PeerId) -> bool {
+        self.promises
+            .get(message)
+            .is_some_and(|peers| peers.contains_key(peer))
+    }
+
     ///Get the peers we sent IWANT the input message id.
     pub(crate) fn peers_for_message(&self, message_id: &MessageId) -> Vec<PeerId> {
         self.promises
diff --git a/beacon_node/lighthouse_network/gossipsub/src/metrics.rs b/beacon_node/lighthouse_network/gossipsub/src/metrics.rs
index d3ca6c299e5..2989f95a26b 100644
--- a/beacon_node/lighthouse_network/gossipsub/src/metrics.rs
+++ b/beacon_node/lighthouse_network/gossipsub/src/metrics.rs
@@ -194,6 +194,12 @@ pub(crate) struct Metrics {
     /// Number of full messages we received that we previously sent a IDONTWANT for.
     idontwant_messages_ignored_per_topic: Family<TopicHash, Counter>,
 
+    /// Count of duplicate messages we have received from mesh peers for a given topic.
+    mesh_duplicates: Family<TopicHash, Counter>,
+
+    /// Count of duplicate messages we have received from by requesting them over iwant for a given topic.
+    iwant_duplicates: Family<TopicHash, Counter>,
+
     /// The size of the priority queue.
     priority_queue_size: Histogram,
     /// The size of the non-priority queue.
@@ -359,6 +365,16 @@ impl Metrics {
             "IDONTWANT messages that were sent but we received the full message regardless"
         );
 
+        let mesh_duplicates = register_family!(
+            "mesh_duplicates_per_topic",
+            "Count of duplicate messages received from mesh peers per topic"
+        );
+
+        let iwant_duplicates = register_family!(
+            "iwant_duplicates_per_topic",
+            "Count of duplicate messages received from non-mesh peers that we sent iwants for"
+        );
+
         let idontwant_bytes = {
             let metric = Counter::default();
             registry.register(
@@ -425,6 +441,8 @@ impl Metrics {
             idontwant_msgs_ids,
             idontwant_messages_sent_per_topic,
             idontwant_messages_ignored_per_topic,
+            mesh_duplicates,
+            iwant_duplicates,
             priority_queue_size,
             non_priority_queue_size,
         }
@@ -597,6 +615,20 @@ impl Metrics {
         }
     }
 
+    /// Register a duplicate message received from a mesh peer.
+    pub(crate) fn mesh_duplicates(&mut self, topic: &TopicHash) {
+        if self.register_topic(topic).is_ok() {
+            self.mesh_duplicates.get_or_create(topic).inc();
+        }
+    }
+
+    /// Register a duplicate message received from a non-mesh peer on an iwant request.
+    pub(crate) fn iwant_duplicates(&mut self, topic: &TopicHash) {
+        if self.register_topic(topic).is_ok() {
+            self.iwant_duplicates.get_or_create(topic).inc();
+        }
+    }
+
     pub(crate) fn register_msg_validation(
         &mut self,
         topic: &TopicHash,