diff --git a/static/img/docs/checks_integrations.png b/static/img/docs/checks_integrations.png new file mode 100644 index 00000000..fe0cb24e Binary files /dev/null and b/static/img/docs/checks_integrations.png differ diff --git a/static/img/docs/details_integrations.png b/static/img/docs/details_integrations.png new file mode 100644 index 00000000..c6c53209 Binary files /dev/null and b/static/img/docs/details_integrations.png differ diff --git a/static/img/docs/email_reports.png b/static/img/docs/email_reports.png new file mode 100644 index 00000000..d412c4cf Binary files /dev/null and b/static/img/docs/email_reports.png differ diff --git a/static/img/docs/monthly_report.png b/static/img/docs/monthly_report.png new file mode 100644 index 00000000..b9a7577b Binary files /dev/null and b/static/img/docs/monthly_report.png differ diff --git a/templates/docs/configuring_notifications.html b/templates/docs/configuring_notifications.html new file mode 100644 index 00000000..fdeb72e0 --- /dev/null +++ b/templates/docs/configuring_notifications.html @@ -0,0 +1,46 @@ +

Configuring Notifications

+

You can set up multiple ways to receive notifications when checks in your account +change state. This is useful for multiple reasons:

+ +

Notification methods ("integrations") are scoped to a project: +if you want to use a notification method in multiple projects, it must be +set up in each project separately.

+

In the web interface, the list of checks shows a visual overview of which alerting +methods are enabled for each check. You can click the icons to toggle them on and off:

+

Integration icons in the checks list

+

You can also toggle the integrations on and off when viewing an individual check:

+

Integration on/off toggles in the check details page

+

Repeated Notifications

+

If you want to receive repeated notifications for as long as a particular check is +down, you have a few different options:

+ +

Email reminder options

+

Monthly Reports

+

SITE_NAME sends monthly email reports at the start of each month. Use them +to make sure all checks have their expected state and nothing has +fallen "through the cracks".

+

A monthly report shows checks from all projects you have access +to. For each check it lists:

+ +

Example monthly report

\ No newline at end of file diff --git a/templates/docs/configuring_notifications.md b/templates/docs/configuring_notifications.md new file mode 100644 index 00000000..e0631078 --- /dev/null +++ b/templates/docs/configuring_notifications.md @@ -0,0 +1,56 @@ +# Configuring Notifications + +You can set up multiple ways to receive notifications when checks in your account +change state. This is useful for multiple reasons: + +* **Redundancy in case of notification failures.** Set up notifications using two different +transports (for example, email and Slack). If one transport fails (e.g., an email +message goes to spam), you still receive the notification over the other transport. +* **Use different notification methods depending on urgency**. For example, if a +low-priority housekeeping script fails, post a message in chat. If a vital service fails, +post in chat, send an email, and send SMS. +* Route notifications to the right people. + +Notification methods ("integrations") are scoped to a project: +if you want to use a notification method in multiple projects, it must be +set up in each project separately. + +In the web interface, the list of checks shows a visual overview of which alerting +methods are enabled for each check. You can click the icons to toggle them on and off: + +![Integration icons in the checks list](IMG_URL/checks_integrations.png) + +You can also toggle the integrations on and off when viewing an individual check: + +![Integration on/off toggles in the check details page](IMG_URL/details_integrations.png) + +## Repeated Notifications + +If you want to receive repeated notifications for as long as a particular check is +down, you have a few different options: + +* If you use an **incident management system** (PagerDuty, VictorOps, OpsGenie, PagerTree, +Pager Team), you can set up escalation rules there. +* Use the **Pushover** integration with the "Emergency" priority. Pushover will +play a loud notification sound on your phone every 5 minutes until the notification +is acknowledged. +* SITE_NAME can send **hourly or daily email reminders** if any check is down +across all projects you have access to. +Set them up in [Account Settings › Email Reports](../../accounts/profile/): + +![Email reminder options](IMG_URL/email_reports.png) + +## Monthly Reports + +SITE_NAME sends monthly email reports at the start of each month. Use them +to make sure all checks have their expected state and nothing has +fallen "through the cracks". + +A monthly report shows checks from all projects you have access +to. For each check it lists: + +* check's current status +* the number of downtimes for two previous months +* the downtime duration for two previous months + +![Example monthly report](IMG_URL/monthly_report.png) \ No newline at end of file diff --git a/templates/front/base_docs.html b/templates/front/base_docs.html index 0e564f92..c11f11c3 100644 --- a/templates/front/base_docs.html +++ b/templates/front/base_docs.html @@ -13,6 +13,7 @@ {% include "front/docs_nav_item.html" with slug="monitoring_cron_jobs" title="Monitoring cron jobs" %} {% include "front/docs_nav_item.html" with slug="configuring_checks" title="Configuring checks" %} + {% include "front/docs_nav_item.html" with slug="configuring_notifications" title="Configuring notifications" %}
  • Pinging Examples
    • {% include "front/docs_nav_item.html" with slug="http_api" title="HTTP API" %}