Integrate with PagerDuty
- 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.
You can configure Cloud Manager to send alerts from your project to your PagerDuty dashboard. With PagerDuty integration, you can:
Record incidents and notify on-call responders based on Cloud Manager alerts.
Automatically resolve incidents in PagerDuty when a Cloud Manager alert is closed with bidirectional synchronization.
How it Works
With a PagerDuty integration, you can send Cloud Manager cluster event data to PagerDuty when Cloud Manager alerts that you specify are triggered. PagerDuty can create a new incident for the corresponding service, filter additional alerts from the same source into that incident, and alert on-call PagerDuty users.
Once the Cloud Manager alert has been resolved, PagerDuty resolves the incident.
Prerequisites
To integrate Cloud Manager with PagerDuty, you must have a PagerDuty account.
If you do not have an existing PagerDuty account, you can sign up at https://www.pagerduty.com/sign-up/.
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 MongoDB Atlas.
Support
If you need help with your Cloud Manager PagerDuty integration, contact MongoDB Support.
Procedure
First, navigate to the PagerDuty integration card:
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.
You can configure a Cloud Manager integration with PagerDuty in two ways:
By signing into PagerDuty from the Cloud Manager Project Integrations page, or
By providing a valid Integration Key.
Sign into PagerDuty
Select PagerDuty services to integrate with MongoDB.
From the dropdown menu, select the PagerDuty service that you want to integrate with MongoDB.
Note
You can select multiple services, but you will be prompted to pick a single default in the next step.
PagerDuty redirects you back to your Cloud Manager project and displays a PagerDuty Configuration modal.
Provide an Integration Key
Important
The PagerDuty Events API does not fail when an invalid Integration Key is provided. If your key is invalid, the Test Integration button may falsely indicate a successful integration.
To confirm that your integration is successful, Cloud Manager sends an initial alert. Check your PagerDuty dashboard for an initial incident created by that Cloud Manager alert.
Remove a PagerDuty Integration
To remove the PagerDuty integration from your Cloud Manager project, click Remove on the PagerDuty card in your Cloud Manager project's Project Integrations.