You can integrate Atlas with third-party monitoring services to receive Atlas alerts in various external monitoring services, and to view and analyze performance metrics that Atlas collects about your cluster.
Note
This page applies to both Atlas Infinite and Atlas Core.
Required Access
To view third-party integration settings, you must have Organization Owner or Project Owner access to the project.
View or Modify Third-Party Settings
Datadog
To create or update a Datadog integration using the Atlas CLI, run the following command:
atlas integrations create DATADOG [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas integrations create DATADOG.
Opsgenie
To create or update an Opsgenie integration using the Atlas CLI, run the following command:
atlas integrations create OPS_GENIE [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas integrations create OPS_GENIE.
PagerDuty
To create or update a PagerDuty integration using the Atlas CLI, run the following command:
atlas integrations create PAGER_DUTY [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas integrations create PAGER_DUTY.
VictorOps
To create or update a VictorOps integration using the Atlas CLI, run the following command:
atlas integrations create VICTOR_OPS [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas integrations create VICTOR_OPS.
Webhook
To create or update a webhook integration using the Atlas CLI, run the following command:
atlas integrations create WEBHOOK [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas integrations create WEBHOOK.
View Third-Party Integrations
To list all third-party integrations for a project using the Atlas CLI, run the following command:
atlas integrations list [options]
To return the details for one third-party integration using the Atlas CLI, run the following command:
atlas integrations describe <integrationType> [options]
To learn more about the syntax and parameters for the previous commands, see the Atlas CLI documentation for atlas integrations list and atlas integrations describe.
Delete a Third-Party Integration
To delete a third-party integration using the Atlas CLI, run the following command:
atlas integrations delete <integrationType> [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas integrations delete.
To modify third-party integration settings using the Atlas UI:
In Atlas, go to the Project Settings 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.
In the sidebar, click the icon next to Project Overview.
The Project Settings page displays.
In Atlas, go to the Project Integrations page.
Click the Integrations tab.
The Project Integrations page displays.
Configure the third-party integrations you want to enable.
Click Configure for the third-party service you wish to modify. You can set one or more of the following:
Third-Party Service | Configuration Details |
|---|---|
Datadog Settings | Configures Atlas to send metric data about your deployment to Datadog. You can view these metrics in your Datadog dashboards. To discover the detailed list of all Atlas metrics that Datadog tracks, refer to the Datadog Integration page.
|
Microsoft Teams Settings | Configures Atlas 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 Atlas. To setup the integration, see Integrate with Microsoft Teams. |
New Relic Settings | IMPORTANT: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration. To learn more, see the New Relic Plugin EOL Statement. Configures Atlas to send metric data about your deployment to New Relic for viewing through the New Relic MongoDB plugin. You can also use Insights for New Relic to run analytics on the collected data. Atlas sends New Relic the same metric data as displayed in Atlas cluster metrics.
If any of the keys later become invalid, Atlas sends an email to the project owner and eventually removes the invalid credentials. |
OpsGenie API Key | Sets an API key for the OpsGenie Alert API. This will be used as the default OpsGenie API key when configuring alerts. (Note that this integration will send the alert to the configured account, not the team.)
|
PagerDuty Service Key | Sets a default service key for alert notifications sent to a PagerDuty account. Atlas 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, Atlas sends an email to the project owner and eventually removes the key. Users can acknowledge PagerDuty alerts only 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 Atlas. |
Slack Settings | Sets a team name, API token and a channel name for alert notifications sent to a Slack account. To configure a Slack integration with OAuth2, click 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 Atlas, your API token is automatically generated and maintained. Atlas redirects you back to the Integrations page. After initially configuring Slack with Atlas, you can Edit or Remove the integration. When you edit the integration, Atlas displays your team name and API token, and allow you to change your channel name. IMPORTANT: Atlas deprecated legacy tokens. You can't configure a new Slack integration with legacy tokens or edit any existing legacy tokens. You can continue to use legacy tokens if you used them to configure a Slack integration prior to deprecation. However, you must reconfigure your Slack integration with OAuth2 if you need to edit your token configuration. |
SumoLogic Settings | Connects you to the relevant SumoLogic documentation for configuring SumoLogic with Atlas. You don't need to configure any settings within Atlas to set up a SumoLogic integration. |
VictorOps Settings | Sets an API key and Routing key for alert notifications sent to a Splunk On-Call (formerly VictorOps) account. Atlas uses this information as the default settings when configuring alerts.
|
Webhook Settings | Adds a Webhook URL endpoint to which Atlas can send alert notifications for programmatic processing. Atlas sends an alert notification as an HTTP POST request. For detailed information about webhook request headers, request body structure, authentication, and limitations, see Integrate with Webhooks. To send alert notifications to a Webhook, select the Webhook notification option when creating or editing an alert. If you add a Webhook notification and the URL or optional key becomes invalid, Atlas sends an email to the project owner and eventually removes the Webhook settings. IMPORTANT: If your firewall configuration requires it, allow access from Atlas IP addresses so that Atlas can communicate with your webhook. |
Prometheus Settings | Configures Atlas to send metric data about your deployment to your Prometheus instance. To learn more, see Integrate with Prometheus. |