@ -0,0 +1,58 @@ | |||
<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, <strong>Period</strong> and <strong>Grace Time</strong>.</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 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> |
@ -0,0 +1,68 @@ | |||
# Configuring Checks | |||
In SITE_NAME, a **Check** 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 [API](../api/). | |||
## Name, Tags, Description | |||
Describe each check using optional name, tags and description fields. | |||
![Editing name, tags and description](IMG_URL/edit_name.png) | |||
* **Name**: 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. | |||
* **Tags**: a space-separated list of optional labels. Use tags to organize and group | |||
checks within a project. You can tag checks by environment | |||
(`prod`, `staging`, `dev`, ...) or by role (`www`, `db`, `worker`, ...) or using | |||
any other system. | |||
* **Description**: 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. | |||
## Simple Schedules | |||
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. | |||
![Editing the period and grace time](IMG_URL/edit_simple_schedule.png) | |||
For simple schedules you configure two time durations, **Period** and **Grace Time**. | |||
* **Period**: the expected time between pings | |||
* **Grace Time**: 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. | |||
## Cron Schedules | |||
Use "cron" for monitoring processes with more complex schedules, and to ensure | |||
jobs run **at the correct time** (not just at correct intervals). | |||
![Editing cron schedule](IMG_URL/edit_cron_schedule.png) | |||
You will need to specify Cron Expression, Server's Time Zone and Grace Time. | |||
* **Cron Expression**: enter the same expression you've used in the crontab. | |||
* **Server's Time Zone**: 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. | |||
* **Grace Time**: same as for simple schedules, how long to wait before sending an alert | |||
for a late check. | |||
## Filtering Rules | |||
![Setting filtering rules](IMG_URL/filtering_rules.png) | |||
* **Allowed request methods for HTTP requests**: 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. | |||
* **Subject must contain**: when pinging via [email](../email/), 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. |
@ -0,0 +1,35 @@ | |||
<h1>Third-Party Resources</h1> | |||
<p>A collection of third-party software projects that integrate with SITE_NAME. | |||
Please submit additions and corrections | |||
<a href="https://github.com/healthchecks/healthchecks/issues">on GitHub</a>.</p> | |||
<h2>Deployment Tools</h2> | |||
<ul> | |||
<li><a href="https://github.com/iphoting/healthchecks/">iphoting/healthchecks</a> – Deploy Healthchecks to Heroku</li> | |||
<li><a href="https://github.com/haswalt/docker-healthchecks">haswalt/docker-healthchecks</a> – Docker image</li> | |||
<li><a href="https://github.com/galexrt/docker-healthchecks">galexrt/docker-healthchecks</a> – Docker image</li> | |||
<li><a href="https://github.com/linuxserver/docker-healthchecks">linuxserver/docker-healthchecks</a> – Docker image</li> | |||
<li><a href="https://galaxy.ansible.com/coaxial/healthchecks">coaxial/healthchecks</a> – Ansible role for deploying Healthchecks</li> | |||
</ul> | |||
<h2>API Wrappers</h2> | |||
<ul> | |||
<li><a href="https://github.com/jwulf/healthchecks.io">jwulf/healthchecks.io</a> – API wrapper in Javascript. Supports pinging.</li> | |||
<li><a href="https://github.com/MyPropertyOffice/node-hchk">MyPropertyOffice/node-hchk</a> – API wrapper in Javascript. Supports listing, creating, updating, deleting, pausing and pinging checks. Supports listing integrations.</li> | |||
<li><a href="https://github.com/gyde-tv/checks">gyde-tv/checks</a> – API wrapper in Ruby. Supports pinging.</li> | |||
<li><a href="https://github.com/kristofferahl/go-healthchecksio">kristofferahl/go-healthchecksio</a> – API wrapper in Go. Supports listing, creating, updating, deleting, pausing, pinging.</li> | |||
<li><a href="https://github.com/frozzare/go-healthchecks">frozzare/go-healthchecks</a> – API wrapper in Go. Supports pinging and failing.</li> | |||
<li><a href="https://github.com/healthchecks/hchk">healthchecks/hchk</a> – API wrapper & CLI in Python. Supports creating, pinging.</li> | |||
<li><a href="https://github.com/pforret/crontask">crontask.sh</a> – bash wrapper to use in crontab. Supports pinging.</li> | |||
</ul> | |||
<h2>Plugins & Integrations</h2> | |||
<ul> | |||
<li><a href="https://github.com/kristofferahl/terraform-provider-healthchecksio">terraform-provider-healthchecksio</a> – Terraform Provider for Healthchecks.io.</li> | |||
<li><a href="https://github.com/prgTW/healthchecks-bundle">prgTW/healthchecks-bundle</a> – Symfony bundle. Supports listing, creating, pinging, pausing.</li> | |||
<li><a href="https://github.com/janiscaunecm/Healthchecks_Magento">janiscaunecm/Healthchecks_Magento</a> – Magento module for Healthchecks.io.</li> | |||
<li><a href="https://github.com/binarybucks/restic-tools">binarybucks/restic-tools</a> – Wrapper around restic backup, with Healthchecks.io support.</li> | |||
<li><a href="https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook">borgmatic</a> – backup software for servers and workstations, includes Healthchecks.io support.</li> | |||
</ul> | |||
<h2>Other</h2> | |||
<ul> | |||
<li><a href="https://github.com/taylus/HealthTray">HealthTray</a> – Watch your healthchecks in Windows system tray.</li> | |||
<li><a href="https://github.com/healthchecks/dashboard">healthchecks/dashboard</a> – A standalone HTML page showing the status of the checks in your account.</li> | |||
</ul> |
@ -0,0 +1,36 @@ | |||
# Third-Party Resources | |||
A collection of third-party software projects that integrate with SITE_NAME. | |||
Please submit additions and corrections | |||
[on GitHub](https://github.com/healthchecks/healthchecks/issues). | |||
## Deployment Tools | |||
* [iphoting/healthchecks](https://github.com/iphoting/healthchecks/) – Deploy Healthchecks to Heroku | |||
* [haswalt/docker-healthchecks](https://github.com/haswalt/docker-healthchecks) – Docker image | |||
* [galexrt/docker-healthchecks](https://github.com/galexrt/docker-healthchecks) – Docker image | |||
* [linuxserver/docker-healthchecks](https://github.com/linuxserver/docker-healthchecks) – Docker image | |||
* [coaxial/healthchecks](https://galaxy.ansible.com/coaxial/healthchecks) – Ansible role for deploying Healthchecks | |||
## API Wrappers | |||
* [jwulf/healthchecks.io](https://github.com/jwulf/healthchecks.io) – API wrapper in Javascript. Supports pinging. | |||
* [MyPropertyOffice/node-hchk](https://github.com/MyPropertyOffice/node-hchk) – API wrapper in Javascript. Supports listing, creating, updating, deleting, pausing and pinging checks. Supports listing integrations. | |||
* [gyde-tv/checks](https://github.com/gyde-tv/checks) – API wrapper in Ruby. Supports pinging. | |||
* [kristofferahl/go-healthchecksio](https://github.com/kristofferahl/go-healthchecksio) – API wrapper in Go. Supports listing, creating, updating, deleting, pausing, pinging. | |||
* [frozzare/go-healthchecks](https://github.com/frozzare/go-healthchecks) – API wrapper in Go. Supports pinging and failing. | |||
* [healthchecks/hchk](https://github.com/healthchecks/hchk) – API wrapper & CLI in Python. Supports creating, pinging. | |||
* [crontask.sh](https://github.com/pforret/crontask) – bash wrapper to use in crontab. Supports pinging. | |||
## Plugins & Integrations | |||
* [terraform-provider-healthchecksio](https://github.com/kristofferahl/terraform-provider-healthchecksio) – Terraform Provider for Healthchecks.io. | |||
* [prgTW/healthchecks-bundle](https://github.com/prgTW/healthchecks-bundle) – Symfony bundle. Supports listing, creating, pinging, pausing. | |||
* [janiscaunecm/Healthchecks_Magento](https://github.com/janiscaunecm/Healthchecks_Magento) – Magento module for Healthchecks.io. | |||
* [binarybucks/restic-tools](https://github.com/binarybucks/restic-tools) – Wrapper around restic backup, with Healthchecks.io support. | |||
* [borgmatic](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook) – backup software for servers and workstations, includes Healthchecks.io support. | |||
## Other | |||
* [HealthTray](https://github.com/taylus/HealthTray) – Watch your healthchecks in Windows system tray. | |||
* [healthchecks/dashboard](https://github.com/healthchecks/dashboard) – A standalone HTML page showing the status of the checks in your account. |
@ -1,56 +0,0 @@ | |||
{% extends "front/base_docs.html" %} | |||
{% load compress static hc_extras %} | |||
{% block title %}Third-Party Resources - {% site_name %}{% endblock %} | |||
{% block description %} | |||
<meta name="description" content="Deployment tools, API wrappers, Plugins and Libraries"> | |||
{% endblock %} | |||
{% block docs_content %} | |||
<h1>Third-Party Resources</h1> | |||
<p>A collection of third-party software projects that integrate | |||
with Healthchecks. Please submit additions and corrections | |||
<a href="https://github.com/healthchecks/healthchecks/issues">on GitHub</a>. | |||
</p> | |||
<h2>Deployment Tools</h2> | |||
<ul> | |||
{% include "front/single_resource.html" with url="https://github.com/iphoting/healthchecks/" name="iphoting/healthchecks" desc="Deploy Healthchecks to Heroku" %} | |||
{% include "front/single_resource.html" with url="https://github.com/haswalt/docker-healthchecks" name="haswalt/docker-healthchecks" desc="Docker image" %} | |||
{% include "front/single_resource.html" with url="https://github.com/galexrt/docker-healthchecks" name="galexrt/docker-healthchecks" desc="Docker image" %} | |||
{% include "front/single_resource.html" with url="https://github.com/linuxserver/docker-healthchecks" name="linuxserver/docker-healthchecks" desc="Docker image" %} | |||
{% include "front/single_resource.html" with url="https://galaxy.ansible.com/coaxial/healthchecks" name="coaxial/healthchecks" desc="Ansible role for deploying Healthchecks" %} | |||
</ul> | |||
<h2>API Wrappers</h2> | |||
<ul> | |||
{% include "front/single_resource.html" with url="https://github.com/jwulf/healthchecks.io" name="jwulf/healthchecks.io" desc="API wrapper in Javascript. Supports pinging." %} | |||
{% include "front/single_resource.html" with url="https://github.com/MyPropertyOffice/node-hchk" name="MyPropertyOffice/node-hchk" desc="API wrapper in Javascript. Supports listing, creating, updating, deleting, pausing and pinging checks. Supports listing integrations." %} | |||
{% include "front/single_resource.html" with url="https://github.com/gyde-tv/checks" name="gyde-tv/checks" desc="API wrapper in Ruby. Supports pinging." %} | |||
{% include "front/single_resource.html" with url="https://github.com/kristofferahl/go-healthchecksio" name="kristofferahl/go-healthchecksio" desc="API wrapper in Go. Supports listing, creating, updating, deleting, pausing, pinging." %} | |||
{% include "front/single_resource.html" with url="https://github.com/frozzare/go-healthchecks" name="frozzare/go-healthchecks" desc="API wrapper in Go. Supports pinging and failing." %} | |||
{% include "front/single_resource.html" with url="https://github.com/healthchecks/hchk" name="healthchecks/hchk" desc="API wrapper & CLI in Python. Supports creating, pinging." %} | |||
{% include "front/single_resource.html" with url="https://github.com/pforret/crontask" name="crontask.sh" desc="bash wrapper to use in crontab. Supports pinging." %} | |||
</ul> | |||
<h2>Plugins & Integrations</h2> | |||
<ul> | |||
{% include "front/single_resource.html" with url="https://github.com/kristofferahl/terraform-provider-healthchecksio" name="terraform-provider-healthchecksio" desc="Terraform Provider for Healthchecks.io." %} | |||
{% include "front/single_resource.html" with url="https://github.com/prgTW/healthchecks-bundle" name="prgTW/healthchecks-bundle" desc="Symfony bundle. Supports listing, creating, pinging, pausing." %} | |||
{% include "front/single_resource.html" with url="https://github.com/janiscaunecm/Healthchecks_Magento" name="janiscaunecm/Healthchecks_Magento" desc="Magento module for Healthchecks.io" %} | |||
{% include "front/single_resource.html" with url="https://github.com/binarybucks/restic-tools" name="binarybucks/restic-tools" desc="Wrapper around restic backup, with Healthchecks.io support." %} | |||
{% include "front/single_resource.html" with url="https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook" name="borgmatic" desc="backup software for servers and workstations, includes Healthchecks.io support." %} | |||
</ul> | |||
<h2>Other</h2> | |||
<ul> | |||
{% include "front/single_resource.html" with url="https://github.com/taylus/HealthTray" name="HealthTray" desc="Watch your healthchecks in Windows system tray" %} | |||
{% include "front/single_resource.html" with url="https://github.com/healthchecks/dashboard" name="healthchecks/dashboard" desc="A standalone HTML page showing the status of the checks in your account. " %} | |||
</ul> | |||
{% endblock %} |
@ -1,3 +0,0 @@ | |||
<li> | |||
<a href="{{ url }}">{{ name }}</a> – {{ desc }} | |||
</li> |