Navigation

Configure Alert Settings

Important
Required Privileges

To manage alerts, you must have the Project Owner role for the project.

For each organization and 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.

Atlas provides no default alerts for organizations.

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
  • Email
  • SMS
  • PagerDuty
  • Flowdock
  • Datadog
  • VictorOps
  • Opsgenie

When you create a new alert, you can clone an existing alert.

1

Navigate to the Alerts page for your organization.

  1. If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
  2. Click Alerts in the sidebar.
2

To create a new alert:

  1. Click Add Alert.

To clone an existing alert setting:

  1. Click the Alert Settings tab.
  2. Locate the alert setting you want to clone.
  3. Click then Clone in that alert setting's row.
3

Click User or Billing under Select a Target.

4

Under Select a Condition:

5

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.

  1. Select the Organization roles that should receive the alerts from the Select Role(s) check boxes or select All Roles for all users in the Organization to receive the alert.
  2. Select SMS to send these alerts to the mobile number configured for each Atlas Organization user in their Account page.
  3. Select Email to send these alerts to the email address configured for each Atlas Organization user in their Account page. Email is checked by default.
Atlas User

Sends the alert by email or text message to a specified Atlas user.

  1. Select SMS to send these alerts to the mobile number configured for the Atlas user in their Account page.
  2. Select Email to send these alerts to the email address configured for the Atlas user in their Account page. Email is checked by default.
Email
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 011 and the country code because Atlas uses the U.S.-based Twilio to send text messages. As an alternative to your non-U.S. telephone number, use a Google Voice telephone number.

Example

For New Zealand enter 01164 before the phone number.

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:

Org Name:
The Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string.
Flow Name:

The flow name in lower-case letters. The flow name appears after the organization name in the URL string:

www.flowdock.com/app/<organization-name>/<flow-name>

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 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.

6

You can configure Maintenance Window Alerts for projects with configured maintenance windows.

1

Navigate to the Alerts page for your project.

  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. Click the Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
2
3

You can configure the following maintenance window alerts:

For the alert you want to configure, click then Edit in that alert setting's row.

4

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.

  1. Select the Project roles that should receive the alerts from the Select Role(s) check boxes or select All Roles for all users in the Project to receive the alert.
  2. Select SMS to send these alerts to the mobile number configured for each Atlas Project user in their Account page.
  3. Select Email to send these alerts to the email address configured for each Atlas Project user in their Account page. Email is checked by default.
Atlas Organization

Sends the alert by email or text message to users with specific roles in the Organization.

  1. Select the Organization roles that should receive the alerts from the Select Role(s) check boxes or select All Roles for all users in the Organization to receive the alert.
  2. Select SMS to send these alerts to the mobile number configured for each Atlas Organization user in Account page.
  3. Select Email to send these alerts to the email address configured for each Atlas Organization user in Account page. Email is checked by default.
Atlas User

Sends the alert by email or text message to a specified Atlas user.

  1. Select SMS to send these alerts to the mobile number configured for the Atlas user in their Account page.
  2. Select Email to send these alerts to the email address configured for the Atlas user in their Account page. Email is checked by default.
Email
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 because Atlas uses the U.S.-based Twilio to send text messages. As an alternative to your non-U.S. telephone number, use a Google Voice telephone number.

Example

For New Zealand enter 01164 before the phone number.

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:

Org Name:
The Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string.
Flow Name:

The flow name in lower-case letters. The flow name appears after the organization name in the URL string:

www.flowdock.com/app/<organization-name>/<flow-name>

User API Token:
Your Flowdock personal API token found on the https://www.flowdock.com/account/tokens page of your Flowdock account.
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.

5
1

Navigate to the Alerts page for your project.

  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. Click the Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
2
3

On the row for a specific alert, click then Disable.

Note

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.

Warning

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.

1

Navigate to the Alerts page for your project.

  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. Click the Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
2
3
  1. On the row for a specific alert, click then Delete.
  2. 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.

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.

Give Feedback