Add BuilderMetrics.

Tracks number of submitter tasks and block number to submit.

Author: twittner

timeboost-builder/src/lib.rs

@@ -1,5 +1,6 @@
 mod certifier;
 mod config;
+mod metrics;
 mod submit;
 
 pub use robusta;

timeboost-builder/src/metrics.rs

@@ -0,0 +1,23 @@
+use metrics::{Gauge, Metrics, NoMetrics};
+
+#[derive(Debug)]
+#[non_exhaustive]
+pub struct BuilderMetrics {
+    pub block_submit: Box<dyn Gauge>,
+    pub submit_tasks: Box<dyn Gauge>,
+}
+
+impl Default for BuilderMetrics {
+    fn default() -> Self {
+        Self::new(&NoMetrics)
+    }
+}
+
+impl BuilderMetrics {
+    pub fn new<M: Metrics>(m: &M) -> Self {
+        Self {
+            block_submit: m.create_gauge("block_submit", None),
+            submit_tasks: m.create_gauge("submit_tasks", None),
+        }
+    }
+}

timeboost-builder/src/submit.rs

@@ -17,7 +17,7 @@ use tokio::{
 use tokio_util::task::TaskTracker;
 use tracing::{debug, warn};
 
-use crate::config::SubmitterConfig;
+use crate::{config::SubmitterConfig, metrics::BuilderMetrics};
 
 const CACHE_SIZE: usize = 15_000;
 const MAX_TASKS: usize = 1000;
@@ -29,6 +29,7 @@ pub struct Submitter {
     handler: Handler,
     committees: Arc<AsyncMutex<CommitteeVec<2>>>,
     task_permits: Arc<Semaphore>,
+    metrics: BuilderMetrics,
 }
 
 impl Drop for Submitter {
@@ -38,7 +39,10 @@ impl Drop for Submitter {
 }
 
 impl Submitter {
-    pub async fn create(cfg: SubmitterConfig) -> Self {
+    pub fn new<M>(cfg: SubmitterConfig, metrics: &M) -> Self
+    where
+        M: ::metrics::Metrics,
+    {
         let client = robusta::Client::new(cfg.robusta.clone());
         let verified = Arc::new(Mutex::new(BTreeSet::new()));
         let committees = Arc::new(AsyncMutex::new(CommitteeVec::new(cfg.committee.clone())));
@@ -62,6 +66,7 @@ impl Submitter {
             submitters: TaskTracker::new(),
             committees,
             task_permits: Arc::new(Semaphore::new(MAX_TASKS)),
+            metrics: BuilderMetrics::new(metrics),
         }
     }
 
@@ -77,14 +82,17 @@ impl Submitter {
         let Ok(permit) = Semaphore::acquire_owned(self.task_permits.clone()).await else {
             return;
         };
+        let num = cb.cert().data().num();
         debug!(
             node  = %self.public_key(),
-            num   = %cb.cert().data().num(),
+            num   = %num,
             tasks = %self.submitters.len(),
             "creating block handler"
         );
         self.submitters
             .spawn(self.handler.clone().handle(permit, cb));
+        self.metrics.block_submit.set(*num as usize);
+        self.metrics.submit_tasks.set(self.submitters.len());
     }
 
     pub async fn join(self) {
@@ -222,6 +230,7 @@ impl Handler {
 #[cfg(test)]
 mod tests {
     use bytes::Bytes;
+    use metrics::NoMetrics;
     use multisig::{Committee, Keypair, PublicKey, Signed, VoteAccumulator};
     use timeboost_types::{Block, BlockInfo, BlockNumber, sailfish::Round};
     use tokio::task::JoinSet;
@@ -296,7 +305,7 @@ mod tests {
                 .committee(committee.clone())
                 .build();
 
-            let mut s = Submitter::create(scfg).await;
+            let mut s = Submitter::new(scfg, &NoMetrics);
 
             tasks.spawn(async move {
                 for _ in 0..NODES {

timeboost/src/lib.rs

@@ -61,6 +61,7 @@ impl Timeboost {
         let met = Arc::new(TimeboostMetrics::new(&*pro));
         let seq = Sequencer::new(cfg.sequencer_config(), &*pro).await?;
         let blk = Certifier::new(cfg.certifier_config(), &*pro).await?;
+        let sub = Submitter::new(cfg.submitter_config(), &*pro);
 
         // TODO: Once we have e2e listener this check wont be needed
         let nitro_forwarder = if let Some(nitro_addr) = cfg.nitro_addr.clone() {
@@ -79,8 +80,6 @@ impl Timeboost {
                 .serve(addr)
         };
 
-        let submitter = Submitter::create(cfg.submitter_config()).await;
-
         Ok(Self {
             metrics_task: spawn(metrics_api(pro.clone(), cfg.metrics_port)),
             label: cfg.sign_keypair.public_key(),
@@ -90,7 +89,7 @@ impl Timeboost {
             _metrics: met,
             nitro_forwarder,
             internal_api: spawn(internal_api),
-            submitter,
+            submitter: sub,
         })
     }