harmacist/healthchecks
1
0
Fork 0
forked from GithubBackups/healthchecks
Code Issues Pull Requests Projects Releases Wiki Activity

Improve "Grace Time" description in docs

Browse Source 
cc: #547
This commit is contained in:
Pēteris Caune 2021-08-09 17:52:20 +03:00
parent 74f56a5501
commit 78113e1aea
No known key found for this signature in database
GPG Key ID: E28D7679E9A9EDE2
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
templates/docs/configuring_checks.html
View File

@ -32,6 +32,11 @@ intervals: once an hour, once a day, once a week.</p>
is late. Use this parameter to account for small, expected deviations in job
execution times.</li>
</ul>
<p>Note: if you use the "start" signal to <a href="../measuring_script_run_time/">measure job run times</a>,
then Grace Time also specifies how long the job is expected to run. Whenever SITE_NAME
receives a "start" signal, it expects to receive a subsequent "success" signal
within Grace Time. If the success signal does not arrive within the configured
Grace Time, SITE_NAME will mark the check as failed and send out alerts.</p>
<h2>Cron Schedules</h2>
<p>Use "cron" for monitoring processes with more complex schedules. This monitoring mode
ensures that jobs run <strong>at the correct time</strong>, and not just at correct time intervals.</p>

6
templates/docs/configuring_checks.md
View File

@ -39,6 +39,12 @@ For the simple schedules, you can configure two parameters, Period and Grace Tim
is late. Use this parameter to account for small, expected deviations in job
execution times.
Note: if you use the "start" signal to [measure job run times](../measuring_script_run_time/),
then Grace Time also specifies how long the job is expected to run. Whenever SITE_NAME
receives a "start" signal, it expects to receive a subsequent "success" signal
within Grace Time. If the success signal does not arrive within the configured
Grace Time, SITE_NAME will mark the check as failed and send out alerts.
## Cron Schedules
Use "cron" for monitoring processes with more complex schedules. This monitoring mode