sim-lib: report results on time interval for more consistent logging

Author: carlaKC

sim-lib/src/lib.rs

@@ -551,6 +551,12 @@ impl Simulation {
 
         let result_logger = Arc::new(Mutex::new(PaymentResultLogger::new()));
 
+        tasks.spawn(run_results_logger(
+            listener.clone(),
+            result_logger.clone(),
+            Duration::from_secs(60),
+        ));
+
         tasks.spawn(consume_simulation_results(
             result_logger,
             results_receiver,
@@ -946,22 +952,17 @@ async fn write_payment_results(
     }
 }
 
-/// PaymentResultLogger is an aggregate logger that will report on a summary of the payments that have been reported
-/// to it at regular intervals (defined by the log_interval it is created with).
+/// PaymentResultLogger is an aggregate logger that will report on a summary of the payments that have been reported.
 #[derive(Default)]
 struct PaymentResultLogger {
     success_payment: u64,
     failed_payment: u64,
     total_sent: u64,
-    call_count: u8,
-    log_interval: u8,
 }
 
 impl PaymentResultLogger {
     fn new() -> Self {
         PaymentResultLogger {
-            // TODO: set the interval at which we log based on the number of payment we're expecting to log.
-            log_interval: 10,
             ..Default::default()
         }
     }
@@ -973,18 +974,44 @@ impl PaymentResultLogger {
         }
 
         self.total_sent += details.amount_msat;
-        self.call_count += 1;
+    }
+}
 
-        if self.call_count % self.log_interval == 0 || self.call_count == 0 {
-            let total_payments = self.success_payment + self.failed_payment;
-            log::info!(
-                "Processed {} payments sending {} msat total with {}% success rate.",
-                total_payments,
-                self.total_sent,
-                (self.success_payment * 100 / total_payments)
-            );
+impl Display for PaymentResultLogger {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        let total_payments = self.success_payment + self.failed_payment;
+        write!(
+            f,
+            "Processed {} payments sending {} msat total with {:.2}% success rate.",
+            total_payments,
+            self.total_sent,
+            (self.success_payment as f64 / total_payments as f64) * 100.0
+        )
+    }
+}
+
+async fn run_results_logger(
+    listener: Listener,
+    logger: Arc<Mutex<PaymentResultLogger>>,
+    interval: Duration,
+) {
+    log::debug!("Results logger started.");
+    log::info!("Summary of results will be reported every {:?}.", interval);
+
+    loop {
+        select! {
+            biased;
+            _ = listener.clone() => {
+                break
+            }
+
+            _ = time::sleep(interval) => {
+                log::info!("{}", logger.lock().await)
+            }
         }
     }
+
+    log::debug!("Results logger stopped.")
 }
 
 /// produce_results is responsible for receiving the outputs of events that the simulator has taken and