summaryrefslogtreecommitdiffstats
path: root/docs/aoa
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2022-04-17 10:32:45 +0200
committernicolargo <nicolas@nicolargo.com>2022-04-17 10:32:45 +0200
commit22ea64477898089aa3270a039a7f60d57d4acaaa (patch)
treeee60c9a1c415d4fe17bf32c20cd38ee01f669b80 /docs/aoa
parentb3c009b22ef6c47a54faa4c8bf4e10bb62caeef4 (diff)
parent96c6faf4738976b62c9497ec78879ac76610dd66 (diff)
Merge from develop
Diffstat (limited to 'docs/aoa')
-rw-r--r--docs/aoa/amps.rst22
-rw-r--r--docs/aoa/header.rst12
-rw-r--r--docs/aoa/memory.rst2
3 files changed, 35 insertions, 1 deletions
diff --git a/docs/aoa/amps.rst b/docs/aoa/amps.rst
index 5de564ab..f6ead33b 100644
--- a/docs/aoa/amps.rst
+++ b/docs/aoa/amps.rst
@@ -50,7 +50,7 @@ less than countmin):
.. image:: ../_static/amp-python-warning.png
If the regex option is not defined, the AMP will be executed every refresh
-time and the process count will not be displayed (countmin and countmax will
+time and the process count will not be displayed (countmin and countmax will
be ignored).
For example:
@@ -63,6 +63,26 @@ For example:
one_line=false
command=sysctl net.netfilter.nf_conntrack_count;sysctl net.netfilter.nf_conntrack_max
+For security reason, pipe is not directly allowed in a AMP command but you create a sheel
+script with your command:
+
+.. code-block:: ini
+
+ $ cat /usr/local/bin/mycommand.sh
+ #!/bin/sh
+ ps -aux | wc -l
+
+and use it in the amps:
+
+.. code-block:: ini
+
+ [amp_amptest]
+ enable=true
+ regex=.*
+ refresh=15
+ one_line=false
+ command=/usr/local/bin/mycommand.sh
+
User defined AMP
----------------
diff --git a/docs/aoa/header.rst b/docs/aoa/header.rst
index f5e7ada8..2e723413 100644
--- a/docs/aoa/header.rst
+++ b/docs/aoa/header.rst
@@ -11,6 +11,18 @@ Additionally, on GNU/Linux, it also shows the kernel version.
In client mode, the server connection status is also displayed.
+It is possible to disable or define time interval to be used for refreshing the
+public IP address (default is 300 seconds) from the configuration
+file under the ``[ip]`` section:
+
+.. code-block:: ini
+ [ip]
+ public_refresh_interval=240
+ public_ip_disabled=True
+
+**NOTE:** Setting low values for `public_refresh_interval` will result in frequent
+HTTP requests to the IP detection servers. Recommended range: 120-600 seconds
+
**Connected**:
.. image:: ../_static/connected.png
diff --git a/docs/aoa/memory.rst b/docs/aoa/memory.rst
index 1df04d06..8d68250a 100644
--- a/docs/aoa/memory.rst
+++ b/docs/aoa/memory.rst
@@ -18,6 +18,8 @@ Stats description:
- **total**: total physical memory available.
- **used**: memory used, calculated differently depending on the platform and
designed for informational purposes only.
+ It's compute as following:
+ used memory = total - free (with free = available + buffers + cached)
- **free**: memory not being used at all (zeroed) that is readily available;
note that this doesn’t reflect the actual memory available (use ‘available’
instead).