healthchecks/templates/docs/configuring_checks.html

<h1>Configuring Checks</h1>
<p>In SITE_NAME, a <strong>Check</strong> represents a single service you want to
monitor. For example, when monitoring cron jobs, you would create a separate check for
each cron job to be monitored. SITE_NAME pricing plans are structured primarily
around how many checks you can have in your account. You can create checks
either in SITE_NAME web interface or by calling <a href="../api/">API</a>.</p>
<h2>Name, Tags, Description</h2>
<p>Describe each check using optional name, tags and description fields.</p>
<p><img alt="Editing name, tags and description" src="IMG_URL/edit_name.png" /></p>
<ul>
<li><strong>Name</strong>: names are optional, but it is a good idea to set them.
Good naming becomes especially important as you add more checks in the
account. Names are displayed in the web interface, in email reports and in the
notifications that SITE_NAME sends out.</li>
<li><strong>Tags</strong>: a space-separated list of optional labels. Use tags to organize and group
checks within a project. You can tag checks by environment
(<code>prod</code>, <code>staging</code>, <code>dev</code>, ...) or by role (<code>www</code>, <code>db</code>, <code>worker</code>, ...) or using
any other system.</li>
<li><strong>Description</strong>: a free-form text field with any related information for your team
or for your future self: what is being monitored, who set it up,
what to do in case of failures, where to look for additional information.</li>
</ul>
<h2>Simple Schedules</h2>
<p>SITE_NAME supports two types of schedules: "simple" and "cron". Use "Simple" schedules
for monitoring processes that are expected to run at relatively regular time
intervals: once an hour, once a day, once a week.</p>
<p><img alt="Editing the period and grace time" src="IMG_URL/edit_simple_schedule.png" /></p>
<p>For simple schedules you configure two time durations, Period and Grace Time.</p>
<ul>
<li><strong>Period</strong>: the expected time between pings</li>
<li><strong>Grace Time</strong>: when a check is late, how long to wait before sending an alert.
Use this variable to account for small, expected deviations in job execution times.</li>
</ul>
<h2>Cron Schedules</h2>
<p>Use "cron" for monitoring processes with more complex schedules, and to ensure
jobs run <strong>at the correct time</strong> (not just at correct time intervals).</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>
<li><strong>Cron Expression</strong>: enter the same expression you've used in the crontab.</li>
<li><strong>Server's Time Zone</strong>: cron daemon typically uses the local time of the machine it is
running on. If the machine is not using UTC timezone, you need to tell SITE_NAME
what timezone to use.</li>
<li><strong>Grace Time</strong>: same as for simple schedules, how long to wait before sending an alert
for a late check.</li>
</ul>
<h2>Filtering Rules</h2>
<p><img alt="Setting filtering rules" src="IMG_URL/filtering_rules.png" /></p>
<ul>
<li><strong>Allowed request methods for HTTP requests</strong>: optionally require the HTTP ping
requests to use HTTP POST. Use this if you run into issues of bots hitting the ping
URLs when you send them in email or post them in chat.</li>
<li><strong>Subject must contain</strong>: when pinging via <a href="../email/">email</a>, require a particular
keyword in the subject line. SITE_NAME will ignore any email messages with the
keyword missing. This is useful, for example, when backup software sends
emails with "Backup Successful" or "Backup Failed" subject lines after each run,
and you want SITE_NAME to ignore the "Backup Failed" messages.</li>
</ul>