Alert settings allow you to control when and how often you will be notified when a check starts failing, degrades or recovers.
The alert settings screen gives you the options to tailor when, how and how often you want to be alerted when a check fails. This is also sometimes referred to as threshold alerting. For example:
- Get an alert on the second or third failure.
- Get an alert after 5 minutes of failures.
- Get one or more reminders after a failure is triggered.
Your alert notifications can be configured at three levels:
- Account level: This is the default level and applies to all of your check unless you override these settings at the check level.
- Group level: You can explicitly override the alert settings at the group level.
- Check level: You can explicitly override the alert settings per check. Very handy for debugging or other one-off cases.
The escalation box allows you to decide when an alert should be triggered. We give you two options:
1. Run based
We alert you when a check has failed a number of times consecutively. We call this a Run Based escalation. Note that failed checks retried from a different region are not considered “consecutive”.
Here’s an example. You want to be alerted after two failures, so you set the escalation to:
Your check runs in Frankfurt and Tokio. It fails from both regions because your server is down. We consider this one run. Five minutes later, the check fails again - assuming the check runs on a 5 minute schedule. Now we alert you.
2. Time based
We alert you when a check is still failing after a period of time, regardless of the amount of check runs that are failing. This option should mostly be used when checks are run very regularly, i.e. once every minute or five minutes.
Here’s an example. You want to be alerted if your check is failing for more than 10 minutes. You set escalation to:
Your check runs every minute. It starts failing at 15:00. Failing check results come in and are visible in the dashboard. After 10 minutes, the clock strikes 15:10. Any failing check results that come in now trigger an alert. If the check has resolved, no alert are triggered.
People are busy, life is complex. For this reason you can set up one or more reminders. With the example below, Checkly would send you two reminders: the first reminder five minutes after the first alert is triggered and the second five minutes after that.
Toggling the “mute” checkbox on a check stops the sending of all alerts but keeps the check running. This is useful when your check might be flapping or showing other unpredictable behavior. Just mute the alerts but keep the check going while you troubleshoot.
You can contribute to this documentation by editing this page on Github