Fixes #18350: Document Health Check in user doc

Normation · Oct 26, 2020 · 5de2678 · 5de2678
1 parent cb57427
commit 5de2678
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/reference/modules/administration/assets/images/healthcheck-ok.png b/src/reference/modules/administration/assets/images/healthcheck-ok.png
diff --git a/src/reference/modules/administration/pages/server.adoc b/src/reference/modules/administration/pages/server.adoc
@@ -211,6 +211,20 @@ Event Categories::
 * Policy Node
 * Archives
 
+== Health Check
+To ensure the health of RUDDER, some checks are executed every 5 minutes by default. To change the period
+you can add `metrics.healthcheck.scheduler.period` in `/opt/rudder/etc/rudder-web.properties`. For example,
+you can change it to "30 seconds". Every check will return a message with a `Severity Level`
+
+Severity Level::
+* Critical: Prevent the proper functioning of RUDDER.
+* Warning: Should be improved, it may cause incidents in the future.
+* Ok: The check was successful.
+
+A notification will be displayed if at least one *Warning* or *Critical* has been returned by a Health Check run.
+
+image::healthcheck-ok.png[All check passed]
+
 == Policy Server
 
 The *Settings -> General* page sum-up information about