summaryrefslogtreecommitdiffstats
path: root/docs/aoa
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2017-05-08 09:46:40 +0200
committernicolargo <nicolas@nicolargo.com>2017-05-08 09:46:40 +0200
commit4ac8368002c9fb4daa90bf68f9778815d5ca4327 (patch)
treec998015d3ab1aa761865a1b26c47dc41fa333b63 /docs/aoa
parentb91241c47f2208651c08abdbd4858fe01ae108d6 (diff)
Update documetation
Diffstat (limited to 'docs/aoa')
-rw-r--r--docs/aoa/cpu.rst23
-rw-r--r--docs/aoa/memory.rst17
2 files changed, 26 insertions, 14 deletions
diff --git a/docs/aoa/cpu.rst b/docs/aoa/cpu.rst
index 8f531bb7..d112d795 100644
--- a/docs/aoa/cpu.rst
+++ b/docs/aoa/cpu.rst
@@ -3,8 +3,10 @@
CPU
===
-The CPU stats are shown as a percentage or value and for the configured
-refresh time. The total CPU usage is displayed on the first line.
+The CPU stats are shown as a percentage or values and for the configured
+refresh time.
+
+The total CPU usage is displayed on the first line.
.. image:: ../_static/cpu.png
@@ -13,6 +15,17 @@ displayed.
.. image:: ../_static/cpu-wide.png
+A character is also displayed just after the CPU header and shows the
+trend value:
+
+======== ==============================================================
+Trend Status
+======== ==============================================================
+``-`` CPU value is equal to the mean of the six latests refreshes
+``\`` CPU value is lower than the mean of the six latests refreshes
+``/`` CPU value is higher than the mean of the six latests refreshes
+======== ==============================================================
+
CPU stats description:
- **user**: percent time spent in user space. User CPU time is the time
@@ -69,9 +82,3 @@ CPU (user/system) Status
.. note::
Limit values can be overwritten in the configuration file under
the ``[cpu]`` and/or ``[percpu]`` sections.
-
-.. note::
- A trend character could be displayed just after the title.
- * '-': value is more or less equal to the mean of the lasts N values
- * '/': value is higher than the mean of the lasts N values
- * '/': value is lower than the mean of the lasts N values
diff --git a/docs/aoa/memory.rst b/docs/aoa/memory.rst
index 37795cb5..05b3df87 100644
--- a/docs/aoa/memory.rst
+++ b/docs/aoa/memory.rst
@@ -12,6 +12,17 @@ the ``RAM``:
.. image:: ../_static/mem-wide.png
+A character is also displayed just after the MEM header and shows the
+trend value:
+
+======== ==============================================================
+Trend Status
+======== ==============================================================
+``-`` MEM value is equal to the mean of the six latests refreshes
+``\`` MEM value is lower than the mean of the six latests refreshes
+``/`` MEM value is higher than the mean of the six latests refreshes
+======== ==============================================================
+
Alerts are only set for used memory and used swap.
Legend:
@@ -28,9 +39,3 @@ RAM/Swap Status
.. note::
Limit values can be overwritten in the configuration file under
the ``[memory]`` and/or ``[memswap]`` sections.
-
-.. note::
- A trend character could be displayed just after the title.
- * '-': value is more or less equal to the mean of the lasts N values
- * '/': value is higher than the mean of the lasts N values
- * '/': value is lower than the mean of the lasts N values