summaryrefslogtreecommitdiffstats
path: root/docs/aoa/events.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/aoa/events.rst')
-rw-r--r--docs/aoa/events.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/aoa/events.rst b/docs/aoa/events.rst
new file mode 100644
index 00000000..88aa88fe
--- /dev/null
+++ b/docs/aoa/events.rst
@@ -0,0 +1,20 @@
+.. _events:
+
+events
+======
+
+.. image:: ../_static/events.png
+
+Events list is displayed in the bottom of the screen if and only if:
+
+- at least one ``WARNING`` or ``CRITICAL`` alert was occurred
+- space is available in the bottom of the console/terminal
+
+Each event message displays the following information:
+
+1. start datetime
+2. duration if alert is terminated or `ongoing` if the alert is still in
+ progress
+3. alert name
+4. {min,avg,max} values or number of running processes for monitored
+ processes list alerts