Configure Alert Settings
On this page
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:
User joined the project (
JOINED_GROUP
)Monitoring is down (
MONITORING_AGENT_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 (
OPLOG_BEHIND
)Backup requires a resync (
RESYNC_REQUIRED
)Cluster is missing an active mongos (
CLUSTER_MONGOS_IS_MISSING
)
If you enter a payment method, Cloud Manager creates the following alert configuration:
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
To configure default settings for one of the above organization notification options:
In MongoDB Cloud Manager, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
Go to the Organization Integrations page.
Click Integrations in the sidebar.
The Organization Integrations page displays.
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 project notification options:
In MongoDB Cloud Manager, go to the Project Integrations page.
If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Next to the Projects menu, expand the Options menu, then click Integrations.
The Project Integrations page displays.
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.
In MongoDB Cloud Manager, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
Go to the Organization Alerts page.
Click Alerts in the sidebar.
The Organization Alerts page displays.
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 | Sends the alert by email or text message to users with specific roles in the Organization.
| ||
Cloud Manager User | Sends the alert to a Cloud Manager user, either by email or text message.
| ||
Email | Sends the alert to any email address you provide. | ||
Mobile Number | 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. For example, for New Zealand, enter 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. | ||
Slack | Sends the alert to a Slack channel in the authorized Slack workplace for the Organization.
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. 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 | Sends the alert to a VictorOps account.
This option displays for alerts that require acknowledgement. You can
use this notification method on information alerts. These alerts
include ones like
Acknowledge VictorOps alerts from the VictorOps dashboard. | ||
Opsgenie | Sends the alert to an Opsgenie account.
This option displays for alerts that require acknowledgement. You can
use this notification method on information alerts. These alerts
include ones like
Acknowledge Opsgenie alerts from the Opsgenie dashboard. |
In MongoDB Cloud Manager, go to the Project Alerts page.
If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Do one of the following steps:
Click the Project Alerts icon in the navigation bar.
Next to the Projects menu, expand the Options menu, click Project Settings, and click Alerts in the sidebar.
The Project Alerts page displays.
Choose whether to create a new alert setting or clone an existing one.
To create a new alert without cloning an existing setting:
Click Add.
Select New 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.
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.
Select the alert recipients and delivery methods.
In the Send to section:
(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.
(Optional) In the resend after field, specify the minutes to elapse before the condition resends the alert.
Click Add and select from the options described in the following table.
Notification OptionDescriptionCloud Manager ProjectSends 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 OrganizationSends 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 UserSends 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 TeamSends 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.
EmailSends 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. For example, for New Zealand, enter
+64
before the phone number.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.
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.
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.
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.
WebhookSends 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.
Delete an Alert Configuration
In MongoDB Cloud Manager, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
Go to the Organization Alerts page.
Click Alerts in the sidebar.
The Organization Alerts page displays.
Choose the alert setting to delete.
On the row for a specific alert, click then Delete.
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.
In MongoDB Cloud Manager, go to the Project Alerts page.
If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Do one of the following steps:
Click the Project Alerts icon in the navigation bar.
Next to the Projects menu, expand the Options menu, click Project Settings, and click Alerts in the sidebar.
The Project Alerts page displays.
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
In MongoDB Cloud Manager, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
Go to the Organization Alerts page.
Click Alerts in the sidebar.
The Organization Alerts page displays.
In MongoDB Cloud Manager, go to the Project Alerts page.
If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Do one of the following steps:
Click the Project Alerts icon in the navigation bar.
Next to the Projects menu, expand the Options menu, click Project Settings, and click Alerts in the sidebar.
The Project Alerts page displays.
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.
In MongoDB Cloud Manager, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
Go to the Organization Alerts page.
Click Alerts in the sidebar.
The Organization Alerts page displays.
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.
In MongoDB Cloud Manager, go to the Project Alerts page.
If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Do one of the following steps:
Click the Project Alerts icon in the navigation bar.
Next to the Projects menu, expand the Options menu, click Project Settings, and click Alerts in the sidebar.
The Project Alerts page displays.
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.