feat(metrics): add utreexo peer count metric

Author: unwrap-nicolas

crates/floresta-wire/src/p2p_wire/node/sync_ctx.rs

@@ -162,6 +162,12 @@ where
                 .and_then(|p| p.channel.send(NodeRequest::Shutdown).ok());
         }
 
+        #[cfg(feature = "metrics")]
+        {
+            use metrics::get_metrics;
+            get_metrics().utreexo_peer_count.set(utreexo_peers as f64);
+        }
+
         if utreexo_peers < 2 {
             info!("Not enough utreexo peers (we have {utreexo_peers}), opening a new connection");
             self.maybe_open_connection(service_flags::UTREEXO.into())?;

metrics/grafana/dashboards/floresta-dashboard.json

@@ -156,11 +156,46 @@
         "overrides": []
       }
     },
+    {
+      "type": "stat",
+      "title": "Utreexo Peer Count",
+      "description": "Number of peers that support the Utreexo protocol. At least 2 are required for block download.",
+      "id": 13,
+      "datasource": { "type": "prometheus", "uid": "${datasource}" },
+      "gridPos": { "h": 3, "w": 24, "x": 0, "y": 7 },
+      "options": {
+        "reduceOptions": { "calcs": ["lastNotNull"], "fields": "", "values": false },
+        "orientation": "horizontal",
+        "textMode": "auto",
+        "colorMode": "background",
+        "graphMode": "none",
+        "justifyMode": "center"
+      },
+      "targets": [
+        { "expr": "max(utreexo_peer_count{instance=~\"$instance\"})", "legendFormat": "utreexo peers", "refId": "A" }
+      ],
+      "fieldConfig": {
+        "defaults": {
+          "unit": "short",
+          "decimals": 0,
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              { "color": "red", "value": null },
+              { "color": "yellow", "value": 1 },
+              { "color": "green", "value": 2 }
+            ]
+          },
+          "color": { "mode": "thresholds" }
+        },
+        "overrides": []
+      }
+    },
     {
       "type": "row",
       "title": "Network",
       "id": 101,
-      "gridPos": { "h": 1, "w": 24, "x": 0, "y": 7 },
+      "gridPos": { "h": 1, "w": 24, "x": 0, "y": 10 },
       "collapsed": false
     },
     {

metrics/src/lib.rs

@@ -17,6 +17,7 @@ pub struct AppMetrics {
     pub memory_usage: Gauge<f64, AtomicU64>,
     pub block_height: Gauge,
     pub peer_count: Gauge<f64, AtomicU64>,
+    pub utreexo_peer_count: Gauge<f64, AtomicU64>,
     pub avg_block_processing_time: Gauge<f64, AtomicU64>,
     pub message_times: Histogram,
 }
@@ -27,6 +28,7 @@ impl AppMetrics {
         let memory_usage = Gauge::<f64, AtomicU64>::default();
         let block_height = Gauge::default();
         let peer_count = Gauge::<f64, AtomicU64>::default();
+        let utreexo_peer_count = Gauge::<f64, AtomicU64>::default();
         let avg_block_processing_time = Gauge::<f64, AtomicU64>::default();
         let message_times = Histogram::new([0.1, 0.5, 1.0, 2.0, 5.0, 10.0, 30.0].into_iter());
 
@@ -36,6 +38,11 @@ impl AppMetrics {
             "Number of connected peers",
             peer_count.clone(),
         );
+        registry.register(
+            "utreexo_peer_count",
+            "Number of connected utreexo peers",
+            utreexo_peer_count.clone(),
+        );
 
         registry.register(
             "avg_block_processing_time",
@@ -60,6 +67,7 @@ impl AppMetrics {
             block_height,
             memory_usage,
             peer_count,
+            utreexo_peer_count,
             avg_block_processing_time,
             message_times,
         }