Docs Menu

Docs Home → MongoDB Atlas

Configure Alert Settings

On this page

  • Default Alert Settings
  • Notification Options
  • Configure an Alert
  • Configure a Maintenance Window Alert
  • View Alert Configurations
  • Disable an Alert
  • Enable an Alert
  • Delete an Alert

For each organization and project, you can select which conditions trigger alerts and how users are notified.

Note

M0 free clusters and M2/M5 shared clusters only trigger alerts related to the metrics supported by those clusters. See Atlas M0 (Free Cluster), M2, and M5 Limitations for complete documentation on M0/M2/M5 alert and metric limitations.

Default Alert Settings

Notification Options

Configure an Alert

When you create a new alert, you can clone an existing alert. You can also update an existing alert configuration.

Configure a Maintenance Window Alert

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

Click Alert Settings.

3

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.

4

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.

  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.

Note

After you create a notification which requires an API or integration key, the key appears partially redacted when you:

  • View or edit the alert through the Atlas UI.

  • Query the alert for the notification through the Atlas Administration API.

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 Administration API Alerts resource.

This option is available only if you have configured Webhook settings on the Integrations page.

Note

When you view or edit the alert for a webhook notification, the URL appears partially redacted, and the secret appears completely redacted.

  1. In the Webhook URL field, specify the target URL for webhook-based alerts.

  2. (Optional) If you set up your Webhook integration with a secret, in the Webhook Secret field, specify the authentication secret for webhook-based alerts.

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.

  1. Enter your DataDog API key under API Key and click Validate Datadog API Key.

  2. Enter your API region.

    Atlas supports the following Datadog regions in the Atlas UI:

    • US1

    • US3

    • US5

    • EU1

    Datadog uses US1 by default.

    To learn more about Datadog's regions, see Datadog Sites.

Note

After you create a notification which requires an API or integration key, the key appears partially redacted when you:

  • View or edit the alert through the Atlas UI.

  • Query the alert for the notification through the Atlas Administration API.

Microsoft Teams

Sends the alert to a Microsoft Teams channel as an Adaptive Card.

To send alert notifications to a Microsoft Teams channel, you must create a Microsoft Teams incoming webhook. After creating the webhook, you can use the automatically generated URL to configure your Microsoft Teams integration in Atlas.

To setup the integration, see Integrate with Microsoft Teams.

Note

When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.

5

Click Save.

View Alert Configurations

Disable an Alert

Enable an Alert

To enable an alert that you previously disabled:

Delete an Alert

←  Review Alert ConditionsResolve Alerts →

On this page

Share Feedback
MongoDB logo
© 2023 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center

Support

Social

© 2023 MongoDB, Inc.