Configure Alert Settings¶
For each organization and project, you can select which conditions trigger alerts and how users are notified.
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 no default alerts for organizations.
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.
Atlas supports Slack as a notification method. From the organization's Settings menu, click Add to Slack in Slack Settings and log in to your preferred Slack workspace.
Atlas supports configuring all of the following notification methods during alert configuration:
- Atlas Organization
- Atlas User
- SMS
- PagerDuty
- Flowdock
- Datadog
- VictorOps
- Opsgenie
Configure an Alert¶
When you create a new alert, you can clone an existing alert.
Navigate to the Alerts page for your organization.¶
- If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
- Click Alerts in the sidebar.
Choose whether to create a new alert setting or clone an existing one.¶
To create a new alert:
- Click Add Alert.
To clone an existing alert setting:
- Click the Alert Settings tab.
- Locate the alert setting you want to clone.
- Click then Clone in that alert setting's row.
Choose the Target.¶
Click User or Billing under Select a Target.
Choose the Condition.¶
Under Select a Condition:
If you chose User, select:
If you chose Billing:
Select from the following options:
- If above $ appears next to the option you selected, specify the amount in USD where Atlas should trigger the alert if the selected condition exceeds that value.
Select the Notification Method.¶
Under the Add Notification Method heading, click the button for the particular notification method you want to use.
Notification Option | User Alerts | Billing Alerts | Description |
---|---|---|---|
Atlas Organization | Sends the alert by email or text message to users with specific roles in the Organization.
| ||
Atlas User | Sends the alert by email or text message to a specified Atlas user.
| ||
Sends the alert to any email address you provide. | |||
Mobile Number | 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 Example For New Zealand enter | ||
Slack | Sends the alert to a Slack channel in the authorized Slack workplace for the Organization. To learn more about Slack authorization, see Authorize Slack to Receive Organization Alerts. Enter the channel name. | ||
Flowdock | Sends the alert to a Flowdock account. Enter the following:
| ||
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 you must acknowledge. Informational alerts like an Atlas user has joined the organization can't use this notification method. Acknowledge PagerDuty alerts from the PagerDuty dashboard. Note PagerDuty decommissioned their v1 API key in October 2018. If you have a v1 key, you can continue to use that key with Atlas. All new PagerDuty keys use their v2 API , but Atlas does not support their v2 key. If you don't have their v1 key, use Webhook instead of PagerDuty. | ||
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. | ||
VictorOps | Sends the alert to a VictorOps account. Enter a VictorOps API key to integrate the VictorOps endpoint for alerts and an optional routing key to route alerts to a specific VictorOps group. Click Post Test Alert to test VictorOps configuration. Define escalation and routing rules directly in VictorOps. This option is available only for alerts that you must acknowledge. Informational alerts like an Atlas user has joined the organization can't use this notification method. Acknowledge VictorOps alerts from the VictorOps dashboard. | ||
Opsgenie | Sends the alert to an Opsgenie account. Enter only the Opsgenie API key. Define escalation rules and alert assignments in Opsgenie. This option is available only for alerts that you must acknowledge. Informational alerts like an Atlas user has joined the organization can't use this notification method. Acknowledge Opsgenie alerts from the Opsgenie dashboard. |
Click Save.¶
Configure a Maintenance Window Alert¶
You can configure Maintenance Window Alerts for projects with configured maintenance windows.
Navigate to the Alerts page for your project.¶
- If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
- If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
- Click the Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
Click Alert Settings.¶
Select the maintenance window alerts you want to configure.¶
You can configure the following maintenance window alerts:
For the alert you want to configure, click then Edit in that alert setting's row.
Select the alert recipients and delivery methods.¶
In the Send to section, click Add and select from the options described in the following table.
Notification Option | Description |
---|---|
Atlas Project | Sends the alert by email or text message to users with specific roles in the Project. Note Atlas Project is the default alert recipient. You can configure the roles the alert is sent to and how it's delivered. You can't add a second Atlas Project as the recipient. Atlas Project is available as an option in the Add list only if it is not currently in the recipients list.
|
Atlas Organization | Sends the alert by email or text message to users with specific roles in the Organization.
|
Atlas User | Sends the alert by email or text message to a specified Atlas user.
|
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 Example For New Zealand enter |
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. To learn more about Bot users in Slack, see https://api.slack.com/bot-users. |
Flowdock | Sends the alert to a Flowdock account. Enter the following:
|
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 Alerts resource. This option is available only if you have configured Webhook settings on the Integrations page. |
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. |
Click Save.¶
Disable an Alert¶
Navigate to the Alerts page for your project.¶
- If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
- If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
- Click the Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
Click Alert Settings.¶
Choose the alert setting to disable.¶
On the row for a specific alert, click then Disable.
Click then Enable to re-enable the alert at any time.
If you 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.
Delete an Alert¶
Don't delete the Maintenance Window Alerts that are created when you configure a maintenance window.
If you delete a maintenance window alert, disable and then re-enable your maintenance window to re-create the alerts.
Navigate to the Alerts page for your project.¶
- If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
- If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
- Click the Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
Click Alert Settings.¶
Choose the alert setting to delete.¶
- On the row for a specific alert, click then Delete.
- Click Confirm in the Confirm Delete modal or click Cancel to leave the alert as configured.
If you delete an alert setting, Atlas cancels active alerts related to the setting. A deleted alert setting does not remain visible.