chore: add downloader metrics

Author: ogenev

Cargo.lock

@@ -0,0 +1,51 @@
+use prometheus_exporter::prometheus::{
+    opts, register_int_gauge_vec_with_registry, IntGaugeVec, Registry,
+};
+
+use crate::portalnet::PORTALNET_METRICS;
+
+/// Contains metrics reporters for portalnet bridge.
+#[derive(Clone, Debug)]
+pub struct DownloaderMetrics {
+    pub current_block: IntGaugeVec,
+}
+
+impl DownloaderMetrics {
+    pub fn new(registry: &Registry) -> anyhow::Result<Self> {
+        let current_block = register_int_gauge_vec_with_registry!(
+            opts!(
+                "downloader_current_block",
+                "the current block number the downloader is on"
+            ),
+            &["downloader"],
+            registry
+        )?;
+        Ok(Self { current_block })
+    }
+}
+
+#[derive(Clone, Debug)]
+pub struct DownloaderMetricsReporter {
+    metrics: DownloaderMetrics,
+}
+
+impl Default for DownloaderMetricsReporter {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl DownloaderMetricsReporter {
+    pub fn new() -> Self {
+        Self {
+            metrics: PORTALNET_METRICS.downloader(),
+        }
+    }
+
+    pub fn report_current_block(&self, block_number: u64) {
+        self.metrics
+            .current_block
+            .with_label_values(&["downloader"])
+            .set(block_number as i64);
+    }
+}

crates/metrics/src/downloader.rs

@@ -2,6 +2,7 @@
 #![warn(clippy::uninlined_format_args)]
 
 pub mod bridge;
+pub mod downloader;
 pub mod labels;
 pub mod overlay;
 pub mod portalnet;

crates/metrics/src/lib.rs

@@ -1,7 +1,10 @@
 use lazy_static::lazy_static;
 use prometheus_exporter::prometheus::default_registry;
 
-use crate::{bridge::BridgeMetrics, overlay::OverlayMetrics, storage::StorageMetrics};
+use crate::{
+    bridge::BridgeMetrics, downloader::DownloaderMetrics, overlay::OverlayMetrics,
+    storage::StorageMetrics,
+};
 
 // We use lazy_static to ensure that the metrics registry is initialized only once, for each
 // runtime. This is important because the registry is a global singleton, and if it is
@@ -17,6 +20,7 @@ fn initialize_metrics_registry() -> PortalnetMetrics {
 
 pub struct PortalnetMetrics {
     bridge: BridgeMetrics,
+    downloader: DownloaderMetrics,
     overlay: OverlayMetrics,
     storage: StorageMetrics,
 }
@@ -27,10 +31,12 @@ impl PortalnetMetrics {
         let overlay = OverlayMetrics::new(registry)?;
         let storage = StorageMetrics::new(registry)?;
         let bridge = BridgeMetrics::new(registry)?;
+        let downloader = DownloaderMetrics::new(registry)?;
         Ok(Self {
             overlay,
             storage,
             bridge,
+            downloader,
         })
     }
 
@@ -45,4 +51,8 @@ impl PortalnetMetrics {
     pub fn bridge(&self) -> BridgeMetrics {
         self.bridge.clone()
     }
+
+    pub fn downloader(&self) -> DownloaderMetrics {
+        self.downloader.clone()
+    }
 }

crates/metrics/src/portalnet.rs

@@ -25,6 +25,7 @@ tokio.workspace = true
 tracing.workspace = true
 tree_hash.workspace = true
 trin-storage.workspace = true
+trin-metrics.workspace = true
 trin-validation.workspace = true
 utp-rs.workspace = true
 portal-bridge.workspace = true

crates/subnetworks/history/Cargo.toml

@@ -28,6 +28,7 @@ use portal_bridge::census::Census;
 use portalnet::{constants::DEFAULT_WEB3_HTTP_ADDRESS, overlay::protocol::OverlayProtocol};
 use ssz_types::BitList;
 use tracing::{info, warn};
+use trin_metrics::downloader::DownloaderMetricsReporter;
 
 use crate::{storage::HistoryStorage, validation::ChainHistoryValidator};
 
@@ -57,6 +58,7 @@ pub struct Downloader {
     pub census: Census,
     pub overlay_arc:
         Arc<OverlayProtocol<HistoryContentKey, XorMetric, ChainHistoryValidator, HistoryStorage>>,
+    pub metrics: DownloaderMetricsReporter,
 }
 
 impl Downloader {
@@ -74,10 +76,13 @@ impl Downloader {
             .map_err(|e| e.to_string())
             .expect("Failed to build http client");
 
+        let metrics = DownloaderMetricsReporter::new();
+
         let census = Census::new(http_client, CENSUS_ENR_LIMIT, vec![]);
         Self {
             overlay_arc,
             census,
+            metrics,
         }
     }
 
@@ -119,6 +124,7 @@ impl Downloader {
         let mut futures = Vec::new();
 
         for (block_number, block_hash) in batch {
+            self.metrics.report_current_block(block_number);
             let block_body_content_key = generate_block_body_content_key(block_hash.clone());
             futures.push(self.find_content(
                 block_body_content_key,