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

Docs: update the "Filtering Rules" section with the new options.

Browse Source
This commit is contained in:
Pēteris Caune 2020-09-01 15:00:41 +03:00
parent ad720af242
commit 0362df55ba
No known key found for this signature in database
GPG Key ID: E28D7679E9A9EDE2
3 changed files with 35 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
static/img/docs/filtering_rules.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 72 KiB

25
templates/docs/configuring_checks.html
View File

@ -45,14 +45,23 @@ what timezone to use.</li>
for a late check.</li>
</ul>
<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>
<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>
<li><strong>Allowed request methods for HTTP requests</strong>. You can require the ping
requests to use HTTP POST. Use the "Only POST" option if you run into issues of
preview bots hitting the ping URLs when you send them in email or post them in chat.</li>
<li><strong>Filter by keywords in the Subject line</strong>. When pinging via <a href="../email/">email</a>,
look for specific keywords in the subject line. If the subject line contains any of
the keywords listed in <strong>Success Keywords</strong>, SITE_NAME will assume it to be a success
signal. Likewise, if it contains any of the keywords listed in <strong>Failure Keywords</strong>,
SITE_NAME will treat it as an explicit failure signal.
This is useful, for example, if your backup software sends an email after each backup
run with a different subject line depending on success or failure.</li>
<li><strong>Pinging a Paused Check</strong>. When you ping a paused check, normally it leaves
the paused state and goes into the "up" or "down" state (depending on the type of
the ping). This changes if you select the "Ignore the ping, stay in the paused state"
option: the paused state becomes "sticky". SITE_NAME will ignore all incoming pings
until you explicitly <em>resume</em> the check.</li>
</ul>

26
templates/docs/configuring_checks.md
View File

@ -56,13 +56,23 @@ for a late check.
## Filtering Rules
In the "Filtering Rules" dialog you can control several advanced aspects of
how SITE_NAME handles incoming pings for a particular check.
![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.
* **Allowed request methods for HTTP requests**. You can require the ping
requests to use HTTP POST. Use the "Only POST" option if you run into issues of
preview bots hitting the ping URLs when you send them in email or post them in chat.
* **Filter by keywords in the Subject line**. When pinging via [email](../email/),
look for specific keywords in the subject line. If the subject line contains any of
the keywords listed in **Success Keywords**, SITE_NAME will assume it to be a success
signal. Likewise, if it contains any of the keywords listed in **Failure Keywords**,
SITE_NAME will treat it as an explicit failure signal.
This is useful, for example, if your backup software sends an email after each backup
run with a different subject line depending on success or failure.
* **Pinging a Paused Check**. When you ping a paused check, normally it leaves
the paused state and goes into the "up" or "down" state (depending on the type of
the ping). This changes if you select the "Ignore the ping, stay in the paused state"
option: the paused state becomes "sticky". SITE_NAME will ignore all incoming pings
until you explicitly *resume* the check.