mirror of
https://github.com/healthchecks/healthchecks.git
synced 2025-04-08 14:40:05 +00:00
Update the "Configuring Checks" docs page with OnCalendar schedules
This commit is contained in:
parent
bb76bf42ac
commit
5d07645823
5 changed files with 37 additions and 12 deletions
Binary file not shown.
Before ![]() (image error) Size: 43 KiB After ![]() (image error) Size: 46 KiB ![]() ![]() |
BIN
static/img/docs/edit_oncalendar_schedule.png
Normal file
BIN
static/img/docs/edit_oncalendar_schedule.png
Normal file
Binary file not shown.
After ![]() (image error) Size: 43 KiB |
Binary file not shown.
Before ![]() (image error) Size: 30 KiB After ![]() (image error) Size: 31 KiB ![]() ![]() |
|
@ -25,9 +25,9 @@ or your future self. Describe the cron job's role, who set it up, what to do in
|
|||
case of failures, and where to look for additional information.</li>
|
||||
</ul>
|
||||
<h2>Simple Schedules</h2>
|
||||
<p>SITE_NAME supports two types of schedules: <strong>Simple</strong> and <strong>Cron</strong>. Use Simple
|
||||
schedules for monitoring processes that you expect to run at relatively regular
|
||||
intervals: once an hour, once a day, once a week, etc.</p>
|
||||
<p>SITE_NAME supports three types of schedules: <strong>Simple</strong>, <strong>Cron</strong>, and <strong>OnCalendar</strong>.
|
||||
Use Simple schedules for monitoring processes that you expect to run at relatively
|
||||
regular intervals: once an hour, once a day, once a week, etc.</p>
|
||||
<p><img alt="Editing the period and grace time" src="IMG_URL/edit_simple_schedule.png" /></p>
|
||||
<p>For the simple schedules, you can configure two parameters, Period and Grace Time.</p>
|
||||
<ul>
|
||||
|
@ -42,9 +42,12 @@ then Grace Time also specifies the maximum allowed time gap between "start" and
|
|||
"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 the correct time
|
||||
intervals.</p>
|
||||
<p>Use "Cron" for monitoring cron jobs and other processes with more complex schedules.
|
||||
This monitoring mode ensures that jobs run <strong>at the correct time</strong> and not just at
|
||||
the correct time intervals.</p>
|
||||
<p>See <a href="../cron/">Cron syntax cheatsheet</a> for cron expression syntax examples.
|
||||
See <a href="https://www.man7.org/linux/man-pages/man5/crontab.5.html">crontab(5) man page</a>
|
||||
for complete cron syntax reference.</p>
|
||||
<p><img alt="Editing cron schedule" src="IMG_URL/edit_cron_schedule.png" /></p>
|
||||
<p>You will need to specify Cron Expression, Server's Time Zone, and Grace Time.</p>
|
||||
<ul>
|
||||
|
@ -55,6 +58,13 @@ timezone here.</li>
|
|||
<li><strong>Grace Time</strong>, same as for simple schedules, is how long to wait before sending an
|
||||
alert for a late check.</li>
|
||||
</ul>
|
||||
<h2>OnCalendar Schedules</h2>
|
||||
<p>Use "OnCalendar" schedules to monitor systemd timers that use <code>OnCalendar=</code> schedules.
|
||||
Same as with systemd timers, you can specify more than one <code>OnCalendar</code> expression,
|
||||
and SITE_NAME will expect a ping whenever any schedule matches.</p>
|
||||
<p>See <a href="https://www.man7.org/linux/man-pages/man7/systemd.time.7.html#CALENDAR_EVENTS">systemd.time(7) man page</a>
|
||||
for complete OnCalendar syntax reference.</p>
|
||||
<p><img alt="Editing cron schedule" src="IMG_URL/edit_oncalendar_schedule.png" /></p>
|
||||
<h2>Filtering Rules</h2>
|
||||
<p>In the "Filtering Rules" dialog, you can control several advanced aspects of
|
||||
how SITE_NAME handles incoming pings for a particular check.</p>
|
||||
|
|
|
@ -30,9 +30,9 @@ case of failures, and where to look for additional information.
|
|||
|
||||
## Simple Schedules
|
||||
|
||||
SITE_NAME supports two types of schedules: **Simple** and **Cron**. Use Simple
|
||||
schedules for monitoring processes that you expect to run at relatively regular
|
||||
intervals: once an hour, once a day, once a week, etc.
|
||||
SITE_NAME supports three types of schedules: **Simple**, **Cron**, and **OnCalendar**.
|
||||
Use Simple schedules for monitoring processes that you expect to run at relatively
|
||||
regular intervals: once an hour, once a day, once a week, etc.
|
||||
|
||||

|
||||
|
||||
|
@ -51,9 +51,13 @@ configured Grace Time, SITE_NAME will mark the check as failed and send out aler
|
|||
|
||||
## Cron Schedules
|
||||
|
||||
Use "cron" for monitoring processes with more complex schedules. This monitoring mode
|
||||
ensures that jobs run **at the correct time** and not just at the correct time
|
||||
intervals.
|
||||
Use "Cron" for monitoring cron jobs and other processes with more complex schedules.
|
||||
This monitoring mode ensures that jobs run **at the correct time** and not just at
|
||||
the correct time intervals.
|
||||
|
||||
See [Cron syntax cheatsheet](../cron/) for cron expression syntax examples.
|
||||
See [crontab(5) man page](https://www.man7.org/linux/man-pages/man5/crontab.5.html)
|
||||
for complete cron syntax reference.
|
||||
|
||||

|
||||
|
||||
|
@ -66,6 +70,17 @@ timezone here.
|
|||
* **Grace Time**, same as for simple schedules, is how long to wait before sending an
|
||||
alert for a late check.
|
||||
|
||||
## OnCalendar Schedules
|
||||
|
||||
Use "OnCalendar" schedules to monitor systemd timers that use `OnCalendar=` schedules.
|
||||
Same as with systemd timers, you can specify more than one `OnCalendar` expression,
|
||||
and SITE_NAME will expect a ping whenever any schedule matches.
|
||||
|
||||
See [systemd.time(7) man page](https://www.man7.org/linux/man-pages/man7/systemd.time.7.html#CALENDAR_EVENTS)
|
||||
for complete OnCalendar syntax reference.
|
||||
|
||||

|
||||
|
||||
## Filtering Rules
|
||||
|
||||
In the "Filtering Rules" dialog, you can control several advanced aspects of
|
||||
|
|
Loading…
Add table
Reference in a new issue