mirror of
https://github.com/healthchecks/healthchecks.git
synced 2025-04-11 15:51:19 +00:00
Improve copy in email.md
This commit is contained in:
parent
00c5b767d4
commit
2ea7ff5950
4 changed files with 31 additions and 13 deletions
templates
|
@ -1491,7 +1491,7 @@ curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v3/badges/
|
|||
|
||||
`GET SITE_ROOT/api/v3/status/`
|
||||
|
||||
Runs a simple datavase query and returns HTTP 200 if the query completes successfully.
|
||||
Runs a test query and returns HTTP 200 if the query completes successfully.
|
||||
Use this endpoint to monitor the uptime of your Healthchecks instance with an
|
||||
external uptime monitoring system.
|
||||
|
||||
|
|
|
@ -2,14 +2,21 @@
|
|||
<p>Alternatively to HTTP/HTTPS requests, you can "ping" checks by
|
||||
sending email messages to special email addresses.</p>
|
||||
<p><img alt="Email address for pinging via email" src="IMG_URL/emails.png" /></p>
|
||||
<h2 id="keyword-filtering">Keyword Filtering</h2>
|
||||
<p>By default, SITE_NAME will consider any email received at the displayed address as
|
||||
a "success" signal. You can also configure SITE_NAME to look for specific
|
||||
a "success" signal. Optionally, you can configure SITE_NAME to look for specific
|
||||
keywords in the subject line or the message body to decide if the message
|
||||
is a "start," a "success," or a "failure" signal.</p>
|
||||
<p>Keywords are case-sensitive and filtered in the following order: SITE_NAME first
|
||||
looks for a failure, then success, then start. If filtering is enabled, an email
|
||||
containing no keywords will be ignored. You can set up keywords in
|
||||
the <strong>Filtering Rules</strong> dialog:</p>
|
||||
<p>SITE_NAME treats keywords as case-sensitive (for example, "Error" and "error" are
|
||||
different keywords), and matches them in a specific order:</p>
|
||||
<ul>
|
||||
<li>SITE_NAME first checks the message for presence of any <strong>failure</strong> keyword.</li>
|
||||
<li>It then checks for any <strong>success</strong> keyword.</li>
|
||||
<li>It then checks for any <strong>start</strong> keyword.</li>
|
||||
<li>If filtering is enabled but none of the keywords match, SITE_NAME <strong>ignores</strong>
|
||||
the email message. The email will show in the event log with an "Ignored" badge.</li>
|
||||
</ul>
|
||||
<p>You can set up keywords inthe <strong>Filtering Rules</strong> dialog:</p>
|
||||
<p><img alt="Setting filtering rules" src="IMG_URL/filtering_rules.png" /></p>
|
||||
<h2>Use Case: Newsletter Delivery Monitoring</h2>
|
||||
<p>Consider a cron job that runs weekly and sends newsletters
|
||||
|
@ -26,4 +33,4 @@ Adjust the grace time parameter for your checks to account for the
|
|||
possible email delivery delays, and avoid false alerts.</p>
|
||||
<p>Tracking job durations (using the "start" and "success" signals) will be less
|
||||
accurate when pinging via email and may not be feasible at all for jobs with
|
||||
very short durations.</p>
|
||||
very short durations.</p>
|
|
@ -5,15 +5,23 @@ sending email messages to special email addresses.
|
|||
|
||||

|
||||
|
||||
## Keyword Filtering {: #keyword-filtering }
|
||||
|
||||
By default, SITE_NAME will consider any email received at the displayed address as
|
||||
a "success" signal. You can also configure SITE_NAME to look for specific
|
||||
a "success" signal. Optionally, you can configure SITE_NAME to look for specific
|
||||
keywords in the subject line or the message body to decide if the message
|
||||
is a "start," a "success," or a "failure" signal.
|
||||
|
||||
Keywords are case-sensitive and filtered in the following order: SITE_NAME first
|
||||
looks for a failure, then success, then start. If filtering is enabled, an email
|
||||
containing no keywords will be ignored. You can set up keywords in
|
||||
the **Filtering Rules** dialog:
|
||||
SITE_NAME treats keywords as case-sensitive (for example, "Error" and "error" are
|
||||
different keywords), and matches them in a specific order:
|
||||
|
||||
* SITE_NAME first checks the message for presence of any **failure** keyword.
|
||||
* It then checks for any **success** keyword.
|
||||
* It then checks for any **start** keyword.
|
||||
* If filtering is enabled but none of the keywords match, SITE_NAME **ignores**
|
||||
the email message. The email will show in the event log with an "Ignored" badge.
|
||||
|
||||
You can set up keywords inthe **Filtering Rules** dialog:
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -39,7 +39,10 @@
|
|||
|
||||
<div class="modal-body">
|
||||
<h2>Inbound Emails</h2>
|
||||
<p>Matching is case-sensitive. <a href="{% url 'hc-serve-doc' 'email' %}">Lean more</a>.</p>
|
||||
<p>
|
||||
Keyword matching is case-sensitive.
|
||||
<a href="{% url 'hc-serve-doc' 'email' %}#keyword-filtering">Lean more</a>.
|
||||
</p>
|
||||
<label class="checkbox-container">
|
||||
<input
|
||||
type="checkbox"
|
||||
|
|
Loading…
Add table
Reference in a new issue