0
0
Fork 0
mirror of https://github.com/healthchecks/healthchecks.git synced 2025-04-11 15:51:19 +00:00

Update filtering rules to specify that they are case sensitive ()

* Update filtering_rules_modal.html

We should specify that the keywords are case sensitive - this isn't obvious to the user.

* Update filtering_rules_modal.html

* Update email.html-fragment

* Update email.md
This commit is contained in:
mmomjian 2024-02-06 02:48:47 -05:00 committed by GitHub
parent 79382ca82e
commit 00c5b767d4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 13 additions and 5 deletions

View file

@ -5,7 +5,10 @@ sending email messages to special email addresses.</p>
<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
keywords in the subject line or the message body to decide if the message
is a "start," a "success," or a "failure" signal. You can set up the keywords in
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><img alt="Setting filtering rules" src="IMG_URL/filtering_rules.png" /></p>
<h2>Use Case: Newsletter Delivery Monitoring</h2>
@ -23,4 +26,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>

View file

@ -8,7 +8,11 @@ sending email messages to special email addresses.
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
keywords in the subject line or the message body to decide if the message
is a "start," a "success," or a "failure" signal. You can set up the keywords in
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:
![Setting filtering rules](IMG_URL/filtering_rules.png)
@ -33,4 +37,4 @@ possible email delivery delays, and avoid false alerts.
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.
very short durations.

View file

@ -39,6 +39,7 @@
<div class="modal-body">
<h2>Inbound Emails</h2>
<p>Matching is case-sensitive. <a href="{% url 'hc-serve-doc' 'email' %}">Lean more</a>.</p>
<label class="checkbox-container">
<input
type="checkbox"
@ -149,4 +150,4 @@
</div>
</form>
</div>
</div>
</div>