• Monitor Your Deployments >
• Configure and Resolve Alerts >
• Configure Alert Settings

Configure Alert Settings

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

• Organization Alerts
• Project Alerts

Cloud Manager provides no default alerts for organizations.

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

• User joined the project

• Host is exposed to the public Internet

• Host's SSL certificate will expire within 30 days
• Monitoring is down

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

• Backup oplog is behind
• Backup requires a resync
• Cluster is missing an active mongos

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

• CREDIT_CARD_ABOUT_TO_EXPIRE

• Host has security recommendations

• Query Targeting: Scanned Objects / Returned is

  Note

  The default configuration sends an alert only if the ratio of documents scanned to documents returned meets or exceeds the specified threshold for at least 10 minutes.

Default Settings for Notification Options

You can configure default settings for the following notification options:

• Cloud Manager Organization
• Cloud Manager User
• Email
• SMS
• HipChat
• Slack
• PagerDuty

• VictorOps
• Opsgenie

You can configure default settings for the following notification options:

• Cloud Manager Organization
• Cloud Manager User
• Email
• SMS
• HipChat
• Slack
• PagerDuty

• 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

Navigate to the Alerts page for your organization.

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.

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.

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. 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 Organization user in their Account page. 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 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.
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 phone number. Cloud Manager removes all letters and punctuation except the +. For international (non-U.S.) phone numbers, format phone numbers using the E.164 standard. Cloud Manager uses the U.S.-based Twilio to send text messages. If you want to use a non-U.S. phone number, try using a Google Voice phone number. Example For New Zealand, enter +64 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 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 the Slack documentation.
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. Acknowledge PagerDuty alerts from the PagerDuty dashboard. Note All new PagerDuty keys use their Events API v2. If you have an Events API v1 key, you can continue to use that key with Cloud Manager.
VictorOps		check icon	Sends the alert to a VictorOps account. In Cloud Manager, enter the following VictorOps setting information: API key. This integrates the VictorOps endpoint for alerts. Routing key. This optional setting routes alerts to a specific VictorOps group. Click Post Test Alert to test VictorOps configuration. Define escalation and routing rules directly in VictorOps. This option displays for alerts that require acknowledgement. You can use this notification method on information alerts. These alerts include ones like User joined the organization. Acknowledge VictorOps alerts from the VictorOps dashboard.
Opsgenie		check icon	Sends the alert to an Opsgenie account. Enter the OpsGenie Alert API key in Cloud Manager. Define escalation rules and alert assignments in Opsgenie. This option displays for alerts that require acknowledgement. You can use this notification method on information alerts. These alerts include ones like User joined the organization. Acknowledge Opsgenie alerts from the Opsgenie dashboard.

6

Click Save.

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

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 filter uses a logical OR operator between each condition.

The matches field can use regular expressions.

5

Select the alert recipients and delivery methods.

In the Send to section:

1. (Optional) To help reduce the false positives that Cloud Manager sends, in the send if condition lasts at least field, specify the minutes to elapse before the condition sends the alert. The next alert check that runs after the specified time elapses sends the alert.

2. (Optional) In the resend after field, specify the minutes to elapse before the condition resends the alert.

3. Click Add and select from the options described in the following table.

   Notification Option	Description
   Cloud Manager Project	Sends the alert by email or text message to users with specific roles in the Project. 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 Project user in their Account page. Select Email to send these alerts to the email address configured for each Cloud Manager Project user in their Account page. Email is checked by default.
   Cloud Manager Organization	Sends the alert by email or text message to users with specific roles in the Organization. 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 Organization user in their Account page. 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	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 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.
   Email	Sends the alert to a specified email address.
   SMS	Sends the alert to a phone number. Cloud Manager removes all letters and punctuation except the +. For international (non-U.S.) phone numbers, format phone numbers using the E.164 standard. Cloud Manager uses the U.S.-based Twilio to send text messages. If you want to use a non-U.S. phone number, try using a Google Voice phone number. Example For New Zealand, enter +64 before the phone number.
   Slack	Sends the alert to a Slack channel in the authorized Slack workplace for the Organization. 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 the Slack documentation.
   PagerDuty	Sends the alert to a PagerDuty account. Enter only the PagerDuty integration key. Define escalation rules and alert assignments directly in PagerDuty. Acknowledge PagerDuty alerts from the PagerDuty dashboard. Note All new PagerDuty keys use their Events API v2. If you have an Events API v1 key, you can continue to use that key with Cloud Manager.
   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. To configure this option, configure the 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

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

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

View the History of Changes to an Alert Configuration

You can view all alerts, alert settings, and deleted alerts on the Organization Alerts page. To learn more, see Alerts Workflow.

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.

You can view open alerts, closed alerts, and alert settings on the Project Alerts page. Cloud Manager sends notifications for all alerts that appear on the Open tab. To learn more, see Alerts Workflow.

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.

←   Review Alert Conditions Resolve Alerts  →

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