Add default interface speed and automatic rate thresolds #718

1 files changed, 30 insertions, 5 deletions

diff --git a/docs/aoa/network.rst b/docs/aoa/network.rst
index 09c25792..c27aba50 100644
--- a/docs/aoa/network.rst
+++ b/docs/aoa/network.rst
@@ -8,16 +8,20 @@ Network
 Glances displays the network interface bit rate. The unit is adapted
 dynamically (bit/s, kbit/s, Mbit/s, etc).
 
-Alerts are only set if the maximum speed per network interface is
-available (see sample in the configuration file).
+If the interface speed is detected (not on all systems), the defaults
+thresholds are applied (70% for careful, 80% warning and 90% critical).
+It is possible to define this percents thresholds form the configuration
+file. It is also possible to define per interface bit rate thresholds.
+In this case thresholds values are define in bps.
 
-It's also possible to define:
+Additionally, you can define:
 
 - a list of network interfaces to hide
 - per-interface limit values
 - aliases for interface name
 
-in the ``[network]`` section of the configuration file.
+The configuration should be done in the ``[network]`` section of the
+Glances configuration file.
 
 For example, if you want to hide the loopback interface (lo) and all the
 virtual docker interface (docker0, docker1, ...):
@@ -25,4 +29,25 @@ virtual docker interface (docker0, docker1, ...):
 .. code-block:: ini
 
     [network]
-    hide=lo,docker.*
+    # Default bitrate thresholds in % of the network interface speed
+    # Default values if not defined: 70/80/90
+    rx_careful=70
+    rx_warning=80
+    rx_critical=90
+    tx_careful=70
+    tx_warning=80
+    tx_critical=90
+    # Define the list of hidden network interfaces (comma-separated regexp)
+    hide=docker.*,lo
+    # WLAN 0 alias
+    wlan0_alias=Wireless IF
+    # It is possible to overwrite the bitrate thresholds per interface
+    # WLAN 0 Default limits (in bits per second aka bps) for interface bitrate
+    wlan0_rx_careful=4000000
+    wlan0_rx_warning=5000000
+    wlan0_rx_critical=6000000
+    wlan0_rx_log=True
+    wlan0_tx_careful=700000
+    wlan0_tx_warning=900000
+    wlan0_tx_critical=1000000
+    wlan0_tx_log=True