Third-Party Service Integrations
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Note
Available with Cloud Manager Standard and Cloud Manager Premium. For more information, Contact MongoDB.
You can integrate Cloud Manager with third-party monitoring services to view and analyze performance metrics that Cloud Manager collects about your cluster.
Required Access
To view or modify third-party integration settings, you must have
Project Monitoring Admin access to the project.
View / Modify Third-Party Settings
To modify third-party integration settings:
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.
Click Configure for the third-party service you want to modify.
You can set the following:
Setting | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty Integration Key | Default service key for alert notifications sent to a PagerDuty account. Cloud Manager enters the key by default when you add a PagerDuty notification to an alert configuration. If you add PagerDuty notifications and if the key used to send the notifications becomes invalid, Cloud Manager sends an email to the project owner and eventually removes the key. You can add PagerDuty notifications only for alerts that require user acknowledgement. Informational alerts, such as the alert that a replica set has elected a new primary, cannot use PagerDuty notification. Users can acknowledge PagerDuty alert notifications only from the PagerDuty dashboard. IMPORTANT: Changing the Integration Key doesn't change any alerts that use this integration. Those alerts still use the previous Integration Key. Remove and re-add each PagerDuty notification(s) to use the new key. 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. | ||||||||||||
HipChat Settings | Default room and API token for alert notifications sent to
a HipChat account. Cloud Manager enters the values by default when
you add a HipChat notification to an alert configuration.
If you add HipChat notifications and the token used to send
notifications becomes invalid, Cloud Manager sends an email to the
Project Owner and eventually removes the token. | ||||||||||||
Slack Settings | WARNING: Before proceeding, you must have a Slack workspace and have sufficient permissions to install a Slack app in your workspace. Team name, API token and a channel name for alert notifications sent to a Slack account. You can configure a Slack integration with OAuth2 by clicking Configure and then Sign in with Slack. When you sign in, you are taken to a Slack landing page where you may select a workspace and configure permissions. After configuring Slack to connect to Cloud Manager, your API token is automatically generated and maintained. You will be redirected back to the Integrations page. After initially configuring Slack with Cloud Manager, you can Edit or Remove the integration. Editing the integration will display your team name and API token, and allow you to change your channel name. IMPORTANT: Legacy tokens are deprecated and will be removed in a future version of Cloud Manager. You cannot edit a legacy token integration. Instead, you must reconfigure your Slack integration with OAuth2. | ||||||||||||
VictorOps Settings | API key and Routing key for alert notifications sent to a VictorOps account. Cloud Manager uses these values as the default VictorOps settings when configuring alerts. Enter the following information from your VictorOps account. If you do not have an existing VictorOps account, you can sign up.
| ||||||||||||
Opsgenie API Key | API key for alert notifications sent to an Opsgenie account. Cloud Manager uses this value as the default OpsGenie Alert API key when configuring alerts. Enter the following information from your Opsgenie account. If you do not have an existing Opsgenie account, you can sign up:
| ||||||||||||
Datadog Settings | Datadog is not supported with Cloud Manager. | ||||||||||||
Webhook Settings | Webhook URL endpoint to which Cloud Manager can send alerts for programmatic processing. Cloud Manager sends an alert as an HTTP POST request in which the request body contains a JSON document that uses the same format as the Cloud Manager API Alerts resource. Cloud Manager adds a request header called
If you specify a key in the Webhook Secret field,
MongoDB Cloud Manager adds the To send alert notifications to a Webhook, select the Webhook
notification option when creating or editing an
alert configuration. If you add a Webhook notification and
the URL or optional key becomes invalid, Cloud Manager sends an email
to the | ||||||||||||
Microsoft Teams Webhook URL | Configures Cloud Manager to send alerts about your project to your Microsoft Teams channel. You can view these alerts in the Adaptive Card displayed in your channel. 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 Cloud Manager. To setup the integration, see Integrate with Microsoft Teams. | ||||||||||||
Prometheus Settings | Configures Cloud Manager to send metric data about your deployment
to your Prometheus instance. To learn more, see
Integrate with Prometheus. |
Build Monitoring Integrations
You can build a monitoring integration using the Cloud Manager API monitoring and alerts endpoints.