- Monitoring and Alerts >
- Configure Alert Settings
Configure Alert Settings¶
On this page
Introduction¶
For a project, you can select which conditions trigger alerts and how users are notified.
Note
M0 Free Tier and M2/M5 shared starter clusters
only trigger alerts related to the metrics supported by
those clusters. See Atlas M0 (Free Tier), M2, and M5 Limitations for complete documentation
on M0/M2/M5 alert and metric limitations.
Default Alert Settings¶
Atlas provides the following default alerts for a new project:
Replica set has no primaryCluster is missing an active mongosDisk space % used on Data Partition isDisk I/O % utilization on Data Partition isUser joined the projectUsers awaiting approval to join projectCredit card is about to expireQuery Targeting: Scanned Objects / ReturnedConnections % of configured limit is
Notification Options¶
When you configure an alert, you select how notifications are sent. You can select multiple notification methods, such as email, text message, or team collaboration tools.
To use certain notification methods, you must first set up Alert Services in the project’s Settings. If the alert services value becomes invalid, Atlas sends an email to the project owner. The following notification methods require set up in Project Settings:
- PagerDuty
- Flowdock
- HipChat
- DataDog
- Slack
- Webhook
Configure an Alert¶
When you create a new alert you have the option of using an existing alert setting as a template.
Click Alerts.¶
Choose whether to clone an existing alert setting as a template.¶
To create a new alert without cloning an existing setting, click the Add button and select New Alert.
To clone an existing setting, click the Alert Settings tab; Locate the alert setting; Click the ellipsis icon and select Clone.
Select the condition that triggers the alert.¶
In the Alert if section, select the target component and the condition. For explanations of alert conditions, see Alert Conditions.
Apply the alert only to specific targets. (Optional)¶
If the options in the For section are available, you can optionally filter the alert to apply only to a subset of the targets.
The matches field can use regular expressions.
Select the alert recipients and delivery methods.¶
In the Send to section, click Add and select from the options described below. To help eliminate false positives, set the time to elapse before the condition triggers the alert.
| Notification Option | Description |
|---|---|
| Project | Sends the alert to a project, either by email or SMS. SMS uses the number configured for each user’s account. To send to specific roles, deselect All Roles and select the roles. |
| Atlas User | Sends the alert to a user, either by email or SMS. SMS uses the number configured for the user’s account. |
| Sends the alert to an email address. | |
| SMS | Sends the alert to a mobile number. Atlas removes all punctuation and letters and uses only the digits. If you are outside of the United States or Canada, include ‘011’ and the country code. For example, for New Zealand enter ‘01164’ before the phone number. As an alternative, use a Google Voice number. Atlas uses the U.S.-based Twilio to send SMS messages. |
| HipChat | Sends the alert to a HipChat room message stream. Enter the HipChat room name and API token. |
| Slack | Sends the alert to a Slack channel. Enter the channel name and either an API token or a Bot token. To create an API token, see the https://api.slack.com/web page in your Slack account. For information on Bot users in Slack, see https://api.slack.com/bot-users. |
| Flowdock | Sends the alert to a Flowdock account. Enter the following: Org Name: The Flowdock organization name in lower-case
letters. This is the name that appears after Flow Name: The flow name in lower-case letters. The flow name appears after the organization name in the URL string:
User API Token: Your Flowdock “personal API token” found on the https://www.flowdock.com/account/tokens page of your Flowdock account. |
| PagerDuty | Sends the alert to a PagerDuty account. Enter only the PagerDuty service key. Define escalation rules and alert assignments directly in PagerDuty. This option is available only for alerts that require acknowledgement. Informational alerts, such as the alert that a user has joined a project, cannot use this notification method. Users can acknowledge PagerDuty alerts only from the PagerDuty dashboard. |
| DataDog | Sends the alert to a DataDog account as a DataDog event. When the alert is first opened, Atlas sends the alert as an “error” event. Subsequent updates are sent as “info” events. When the alert is closed, Atlas sends a “success” event. If prompted, enter your DataDog API key under API Key and click Validate Datadog API Key. |
| Webhook | Sends an HTTP POST request to an endpoint for programmatic processing.
The request body contains a JSON document that uses the same format as
the Atlas API’s Grant the following CIDR ranges access to the endpoint resource:
Important MongoDB reserves the right to change these IP addresses at any time without user notice. |
Click Save.¶
Delete or Disable an Alert¶
If you delete or disable an alert setting, Atlas cancels active alerts related to the setting. A disabled alert setting remains visible but grayed-out and can be later re-enabled. A deleted alert setting does not remain visible.