Navigation

Manage Alert Configurations

Overview

An alert configuration defines the conditions that trigger an alert and the alert’s notification methods. An alert configuration applies to the project in which you create it.

Considerations

SMS Delivery

Many factors may affect alert delivery, including do not call lists, caps for messages sent or delivered, delivery time of day, and message caching.

Check with your telephone service contract for the costs associated with receiving text messages.

If you choose SMS, Cloud Manager sends alert text messages to all users in the project who have a mobile number associated with their user account.

Alert Intervals

You can create multiple alert configurations with different frequencies. The minimum frequency for an alert is 5 minutes.

The time between re-notifications increases by the frequency amount every alert cycle up to a maximum of 24 hours. For example, if the frequency amount is 5 minutes, and the alert condition is first triggered at 9am, subsequent alerts occur at 9:05am, 9:15am, 9:30am, etc.

You can set the time to elapse before Cloud Manager sends an alert after an alert condition occurs. This helps eliminate false positives.

Default Alert Configurations

Cloud Manager provides no default alerts for organizations.

Cloud Manager creates the following alert configurations for a project automatically upon creation of the project:

If you enable Backup, Cloud Manager creates the following alert configurations for the project, if they do not already exist:

If you enter a payment method, Cloud Manager creates the following alert configuration:

Default Settings for Notification Options

You can configure default settings for the following notification options:

  • Cloud Manager Organization
  • Cloud Manager User
  • Email
  • SMS
  • Slack
  • PagerDuty
  • Flowdock
  • VictorOps
  • Opsgenie

You can configure default settings for the following notification options:

  • Cloud Manager Organization
  • Cloud Manager User
  • Email
  • SMS
  • Slack
  • PagerDuty
  • Flowdock
  • VictorOps
  • Opsgenie

To configure default settings for one of the above notification options, click Integrations under Projects in the sidebar. Locate the notification option and enter the default values.

Cloud Manager will fill in the default values automatically when a user selects that option when creating an alert configuration. If the key, token, or URL that is used to send the notification becomes invalid, Cloud Manager will send an email to the project owner and will eventually remove the key, token, or URL.

Create an Alert Configuration

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

1
2

Choose whether to create a new alert setting or clone an existing one.

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 ellipsis h icon then Clone in that alert setting’s row.
3

Choose the Target.

Click User or Billing under Select a Target.

4

Choose the Condition.

Under Select a Condition:

  • If you chose User:
    1. Select from the available options.
    2. Click Next.
  • If you chose Billing:
    1. Select from the available options.
    2. If above $ appears next to the option you selected, specify the amount in USD where MongoDB Atlas should trigger the alert if the selected condition exceeds that value.
    3. Click Next.
5

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
Cloud Manager Organization check icon check icon

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 Cloud Manager Organization user in their Account page.
  3. Select Email to send these alerts to the email
    address configured for each Cloud Manager Organization user in their Account page. Email is checked by default.
Cloud Manager User check icon check icon

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

  1. Select SMS to send these alerts to the mobile
    number configured for the Cloud Manager user in their Account page.
  2. Select Email to send these alerts to the email
    address configured for the Cloud Manager user in their Account page. Email is checked by default.
Email check icon check icon Sends the alert to any email address you provide.
Mobile Number check icon check icon

Sends the alert to a mobile number. Cloud Manager 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 Cloud Manager 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 check icon check icon Sends the alert to a Slack channel in the authorized Slack workplace for the Organization. Enter the channel name.
Flowdock check icon check icon

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   check icon

Sends the alert to a PagerDuty account. Enter only the PagerDuty integration key. Define escalation rules and alert assignments directly in PagerDuty.

This option is available only for alerts that require an acknowledgement. Information alerts, such as User joined the organization, can’t use this notification method.

Acknowledge PagerDuty alerts from the PagerDuty dashboard.

VictorOps   check icon

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 require an acknowledgement. Information alerts, such as User joined the organization, can’t use this notification method.

Acknowledge VictorOps alerts from the VictorOps dashboard.

Opsgenie   check icon

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 require an acknowledgement. Information alerts, such as User joined the organization, can’t use this notification method.

Acknowledge Opsgenie alerts from the Opsgenie dashboard.

6

Click Save.

1
2

Choose whether to create a new alert setting or clone an existing one.

To create a new alert without cloning an existing setting:

  1. Click Add.
  2. Select New Alert.

To clone an existing alert setting:

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

Select the condition that triggers the alert.

In the Alert if section, select the target component and the condition. To learn more about alert conditions, see Alert Event Types.

4

Optional: Apply the alert only to specific targets.

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.

5

Select the alert recipients and delivery methods.

In the Send to section, click Add and select from the options described in the following table.

To help eliminate false positives, set the time to elapse before the condition triggers the alert.

Notification Option Description
Cloud Manager Project

Sends the alert to users with specific roles in the Project, either by email or text message.

  • 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.
  • Select SMS to send these alerts to the mobile number configured for each Cloud Manager user’s account.
  • Select Email to send these alerts to the email address configured for each Cloud Manager user’s account. Email is checked by default.
Cloud Manager Organization

Sends the alert to users with specific roles in the organization, either by email or text message.

  • 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.
  • Select SMS to send these alerts to the mobile number configured for each Cloud Manager user’s account.
  • Select Email to send these alerts to the email address configured for each Cloud Manager user’s account. Email is checked by default.
Cloud Manager User

Sends the alert to a Cloud Manager user, either by email or text message.

  • Select SMS to send these alerts to the mobile number configured for the Cloud Manager user’s account.
  • Select Email to send these alerts to the email address configured for the Cloud Manager user’s account. Email is checked by default.
Cloud Manager Team

Sends the alert to a specified Cloud Manager team, either by email or text message.

  • Select SMS to send these alerts to the mobile number configured for the Cloud Manager user’s account.
  • Select Email to send these alerts to the email address configured for the Cloud Manager user’s account. Email is checked by default.

Note

This option appears only after at least one team has been created.

Email Sends the alert to a specified email address.
SMS

Sends the alert to a mobile number. Cloud Manager 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 Cloud Manager 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 API page in your Slack account. To learn more about Bot users in Slack, see Bot Users.

FlowDock

Sends the alert to a Flowdock account. Enter the following:

  • Organization Name: The Flowdock organization :name in lowercase letters. This is the name that appears :after www.flowdock.com/app/ in the URL string.
  • Flow Name: The flow name in lowercase letters. The flow name appears after the org name in the URL: www.flowdock.com/app/orgname/flowname.
  • User API Token: Your Flowdock “personal API token” found on the Tokens page of your Flowdock account.
PagerDuty

Sends the alert to a PagerDuty account. Enter only the PagerDuty integration 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 replica set has elected a new primary, cannot use this notification method.

Users can acknowledge PagerDuty alerts only from the PagerDuty dashboard.

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 Cloud Manager API Alerts resource. This option is available only if you have configured Webhook settings on the Project Settings page.

To ensure your Webhooks work, configure your firewall to permit the Webhooks to access Cloud Manager.

6

Click Save.

Delete an Alert Configuration

1
2

Choose the alert setting to delete.

  1. On the row for a specific alert, click ellipsis h icon then Delete.

  2. Click Delete in the Delete Alert modal or click Cancel to leave the alert as configured.

    Note

    If you have not logged in within the five minutes of pushing Delete, you need to re-enter your password, then click Delete again.

1
2

Choose the alert setting to delete.

  1. On the row for a specific alert, click ellipsis h icon 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, Cloud Manager cancels active alerts related to the setting. A deleted alert setting does not remain visible.

Disable or Enable an Alert Configuration

1

Navigate to Alert Settings.

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

Choose the alert setting to disable.

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

Click ellipsis h icon then Enable to re-enable the alert at any time.

1

Navigate to the Alert Settings tab.

  1. If it is not already displayed, select the organization that contains your desired project from the office icon 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 bell icon Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
  4. Click the Alert Settings tab.
2

Choose the alert setting to disable.

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

Note

Click ellipsis h icon then Enable to re-enable the alert at any time.

If you disable an alert setting, Cloud Manager cancels active alerts related to the setting. A disabled alert setting remains visible but grayed-out and can be later re-enabled.

If you need to disable an alert only for a period of time, you can alternatively suspend alerts.

View the History of Changes to an Alert Configuration

1

Navigate to the Alert Settings tab.

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

On the line listing the alert configuration, click the ellipsis icon and select History.

Cloud Manager displays the history of changes to the alert configuration.

1

Navigate to the Alert Settings tab.

  1. If it is not already displayed, select the organization that contains your desired project from the office icon 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 bell icon Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
  4. Click the Alert Settings tab.
2

Click either the Active Alerts or Deleted Alerts filter, depending on the configuration’s status.

3

On the line listing the alert configuration, click the ellipsis icon and select History.

Cloud Manager displays the history of changes to the alert configuration.