blockchain_stuck_notifier: configurable interval after which a warning will occur

Author: eugene-babichenko

doc/quickstart/02_passive_node.md

@@ -84,6 +84,9 @@ Description of the fields:
       this node should maintain.
 - `explorer`: (optional) Explorer settings
     - `enabled`: True or false
+- `no_blockchain_updates_warning_interval`: (optional, seconds) if no new blocks
+  were received after this period of time, the node will start sending you
+  warnings in the logs.
 
 [multiaddr]: https://github.com/multiformats/multiaddr
 

jormungandr/src/blockchain_stuck_notifier.rs

@@ -10,14 +10,17 @@ use tokio::timer::Interval;
 pub fn check_last_block_time(
     service_info: TokioServiceInfo,
     blockchain_tip: blockchain::Tip,
+    check_interval: u64,
 ) -> impl Future<Item = (), Error = ()> {
     let logger = service_info.logger().clone();
     let err_logger = logger.clone();
 
-    // TODO set from configuration
-    let check_period = Duration::from_secs(180);
+    // those are different values, because check_interval can be big
+    // (30 minutes) and the notification may remain unseen
+    let check_period = Duration::from_secs(check_interval);
+    let notification_period = Duration::from_secs(60);
 
-    Interval::new_interval(check_period.clone())
+    Interval::new_interval(notification_period)
         .map_err(move |e| error!(err_logger, "timer error: {}", e))
         .and_then(move |_| blockchain_tip.get_ref())
         .for_each(move |tip| {

jormungandr/src/main.rs

@@ -296,9 +296,17 @@ fn start_services(bootstrapped_node: BootstrappedNode) -> Result<(), start_up::E
 
     {
         let blockchain_tip = blockchain_tip.clone();
+        let no_blockchain_updates_warning_interval = bootstrapped_node
+            .settings
+            .no_blockchain_updates_warning_interval
+            .clone();
 
         services.spawn_future("blockchain_stuck_notifier", move |info| {
-            blockchain_stuck_notifier::check_last_block_time(info, blockchain_tip)
+            blockchain_stuck_notifier::check_last_block_time(
+                info,
+                blockchain_tip,
+                no_blockchain_updates_warning_interval,
+            )
         });
     }
 

jormungandr/src/settings/start/config.rs

@@ -30,6 +30,9 @@ pub struct Config {
     pub p2p: P2pConfig,
 
     pub explorer: Option<Explorer>,
+
+    /// the time interval with no blockchain updates after which alerts are thrown
+    pub no_blockchain_updates_warning_interval: Option<u64>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]

jormungandr/src/settings/start/mod.rs

@@ -14,6 +14,7 @@ use std::{fs::File, path::PathBuf};
 const DEFAULT_FILTER_LEVEL: FilterLevel = FilterLevel::Info;
 const DEFAULT_LOG_FORMAT: LogFormat = LogFormat::Plain;
 const DEFAULT_LOG_OUTPUT: LogOutput = LogOutput::Stderr;
+const DEFAULT_NO_BLOCKCHAIN_UPDATES_WARNING_INTERVAL: u64 = 1800; // 30 min
 
 custom_error! {pub Error
    ConfigIo { source: std::io::Error } = "Cannot read the node configuration file: {source}",
@@ -34,6 +35,7 @@ pub struct Settings {
     pub mempool: Mempool,
     pub leadership: Leadership,
     pub explorer: bool,
+    pub no_blockchain_updates_warning_interval: u64,
 }
 
 pub struct RawSettings {
@@ -173,6 +175,10 @@ impl RawSettings {
                 .as_ref()
                 .map_or(Leadership::default(), |cfg| cfg.leadership.clone()),
             explorer,
+            no_blockchain_updates_warning_interval: config
+                .as_ref()
+                .and_then(|config| config.no_blockchain_updates_warning_interval)
+                .unwrap_or(DEFAULT_NO_BLOCKCHAIN_UPDATES_WARNING_INTERVAL),
         })
     }
 }