network monitoring

docs/nixos-options.md

@@ -33,7 +33,7 @@ List of enabled check sets\. Each check set is a module which checks something a
 
 
 *Type:*
-list of (one of “start”, “stop”, “cpu”, “ram”, “temp”, “vulnix”)
+list of (one of “start”, “stop”, “remind”, “cpu”, “ram”, “temp”, “net”, “vulnix”)
 
 
 
@@ -52,7 +52,7 @@ CPU load percentage for a critical alert to be sent\. Null means never generate
 
 
 *Type:*
-null or floating point number
+null or (positive integer or floating point number, meaning >0)
 
 
 
@@ -73,7 +73,7 @@ CPU load percentage for a warning alert to be sent\. Null means never generate a
 
 
 *Type:*
-null or floating point number
+null or (positive integer or floating point number, meaning >0)
 
 
 
@@ -85,6 +85,166 @@ null or floating point number
 
 
 
+## services\.lego-monitoring\.checks\.net\.interfaces
+
+
+
+Per-interface configuration of IO byte thresholds\.
+
+
+
+*Type:*
+attribute set of (submodule)
+
+
+
+*Default:*
+` { } `
+
+
+
+*Example:*
+
+```
+{
+  br0 = {
+    warningThresholdCombBytes = 700 * 1024 * 128;        # 700 Megabits
+    criticalThresholdCombBytes = 1 * 1024 * 1024 * 128;  # 1 Gigabit
+  };
+}
+```
+
+*Declared by:*
+ - [modules/options\.nix](../modules/options.nix)
+
+
+
+## services\.lego-monitoring\.checks\.net\.interfaces\.\<name>\.criticalThresholdCombBytes
+
+
+
+Combined (sent + received) bytes per second threshold for a critical alert to be sent\. If null, this threshold is disabled and not checked\.
+
+
+
+*Type:*
+null or (positive integer, meaning >0)
+
+
+
+*Default:*
+` null `
+
+*Declared by:*
+ - [modules/options\.nix](../modules/options.nix)
+
+
+
+## services\.lego-monitoring\.checks\.net\.interfaces\.\<name>\.criticalThresholdRecvBytes
+
+
+
+Received bytes per second threshold for a critical alert to be sent\. If null, this threshold is disabled and not checked\.
+
+
+
+*Type:*
+null or (positive integer, meaning >0)
+
+
+
+*Default:*
+` null `
+
+*Declared by:*
+ - [modules/options\.nix](../modules/options.nix)
+
+
+
+## services\.lego-monitoring\.checks\.net\.interfaces\.\<name>\.criticalThresholdSentBytes
+
+
+
+Sent bytes per second threshold for a critical alert to be sent\. If null, this threshold is disabled and not checked\.
+
+
+
+*Type:*
+null or (positive integer, meaning >0)
+
+
+
+*Default:*
+` null `
+
+*Declared by:*
+ - [modules/options\.nix](../modules/options.nix)
+
+
+
+## services\.lego-monitoring\.checks\.net\.interfaces\.\<name>\.warningThresholdCombBytes
+
+
+
+Combined (sent + received) bytes per second threshold for a warning alert to be sent\. If null, this threshold is disabled and not checked\.
+
+
+
+*Type:*
+null or (positive integer, meaning >0)
+
+
+
+*Default:*
+` null `
+
+*Declared by:*
+ - [modules/options\.nix](../modules/options.nix)
+
+
+
+## services\.lego-monitoring\.checks\.net\.interfaces\.\<name>\.warningThresholdRecvBytes
+
+
+
+Received bytes per second threshold for a warning alert to be sent\. If null, this threshold is disabled and not checked\.
+
+
+
+*Type:*
+null or (positive integer, meaning >0)
+
+
+
+*Default:*
+` null `
+
+*Declared by:*
+ - [modules/options\.nix](../modules/options.nix)
+
+
+
+## services\.lego-monitoring\.checks\.net\.interfaces\.\<name>\.warningThresholdSentBytes
+
+
+
+Sent bytes per second threshold for a warning alert to be sent\. If null, this threshold is disabled and not checked\.
+
+
+
+*Type:*
+null or (positive integer, meaning >0)
+
+
+
+*Default:*
+` null `
+
+*Declared by:*
+ - [modules/options\.nix](../modules/options.nix)
+
+
+
 ## services\.lego-monitoring\.checks\.ram\.criticalPercentage
 
 
@@ -94,7 +254,7 @@ RAM usage percentage for a critical alert to be sent\. Null means never generate
 
 
 *Type:*
-null or floating point number
+null or (positive integer or floating point number, meaning >0)
 
 
 
@@ -115,7 +275,7 @@ RAM usage percentage for a warning alert to be sent\. Null means never generate
 
 
 *Type:*
-null or floating point number
+null or (positive integer or floating point number, meaning >0)
 
 
 
@@ -265,7 +425,7 @@ Critical temperature threshold\.
 
 
 *Type:*
-null or floating point number
+null or (positive integer or floating point number, meaning >0)
 
 
 
@@ -307,7 +467,7 @@ Warning temperature threshold\.
 
 
 *Type:*
-null or floating point number
+null or (positive integer or floating point number, meaning >0)