About Consul Alerts
Team Notification Methods
Alerts are sent to notification methods associated with teams, such as "Engineering Slack" or "Ops Pagerduty". Teams and their notification methods can be managed by visiting the Settings page for your organization.
You must have at least one team with configured notification methods to receive alerts.
Alert preferences are configured by visiting the Integrations page on any Consul environment.
There are 3 types of alert preferences:
- Logical services are triggered when a percentage of a service is unhealthy threshold across your Consul cluster.
- Services are triggered when a service is unhealthy on any node
- Nodes are triggered when a node is unhealthy.
In addition, you can receive SCADA Connection alerts when Atlas can no longer communicate with your Consul cluster.
Each alert preference has fields for matching nodes/service IDs/check IDS, a status threshold, team destinations, and the ability to be temporarily muted. Logical services also have a configurable unhealthy threshold.
Alert Matching with Regular Expressions
The Node, Check ID, and Service ID fields support regular
expressions for matching
alerts, and default to
.* (match anything, including empty). For instance, if
you wanted to create an alert preference which matches both
database-secondary, you could use the regular expression
There are a few rules which Atlas uses while matching regular expressions to keep in mind:
- Case insensitive -
- Implicit being/end -
databaseis equivalent to
^database$, and will not match
|Regular Expression||Will Match||Will Not Match|
||Anything, including empty strings|
Alerts can be triggered with a status of
Node and Service alerts can be filtered based on their status:
- any will match any alerts.
- warning, critical will only match slerts with a status of
- critical will only match
Logical Service alert preferences only support
SCADA Connection alerts are always sent.
In order to receive alerts, the alert preference must have at least one team destination configured, such as "Engineering Slack (#engineering)" or "Ops Pagerduty". Team destinations can be configured by visiting the Settings page for your organization.
If multiple alert preferences match the same alert, each team destination will only notified once.
Any alert preference can be muted for preset durations. While an alert preference is muted, the alert preference will not match any alerts, and not generate any notifications for configured team destinations.
Note that if multiple alert preferences match an alert and not all of them are muted, the non-muted preferences will still trigger a notification for the respective team destinations.