Browse Source

Improve "Grace Time" description in docs

cc: #547
pull/551/head
Pēteris Caune 3 years ago
parent
commit
78113e1aea
No known key found for this signature in database GPG Key ID: E28D7679E9A9EDE2
2 changed files with 11 additions and 0 deletions
  1. +5
    -0
      templates/docs/configuring_checks.html
  2. +6
    -0
      templates/docs/configuring_checks.md

+ 5
- 0
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 is late. Use this parameter to account for small, expected deviations in job
execution times.</li> execution times.</li>
</ul> </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> <h2>Cron Schedules</h2>
<p>Use "cron" for monitoring processes with more complex schedules. This monitoring mode <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> ensures that jobs run <strong>at the correct time</strong>, and not just at correct time intervals.</p>


+ 6
- 0
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 is late. Use this parameter to account for small, expected deviations in job
execution times. 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 ## Cron Schedules
Use "cron" for monitoring processes with more complex schedules. This monitoring mode Use "cron" for monitoring processes with more complex schedules. This monitoring mode


Loading…
Cancel
Save