Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes #18350: Document Health Check in user doc #794

Merged
merged 1 commit into from Oct 27, 2020
Merged

Fixes #18350: Document Health Check in user doc #794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added src/reference/modules/administration/assets/images/healthcheck-ok.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions src/reference/modules/administration/pages/server.adoc
View file
Open in desktop
Expand Up @@ -211,6 +211,21 @@ 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`
amousset marked this conversation as resolved.
Show resolved Hide resolved
through the https://docs.rudder.io/api/#tag/Healthcheck[Health Check API]

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 latest Health Check run.

image::healthcheck-ok.png[All check passed]

== Policy Server

The *Settings -> General* page sum-up information about
Expand Down