Docs Menu
Docs Home
/
MongoDB Atlas
/
Monitor Clusters
/
Third-Party Services

Integrate with PagerDuty

On this page

  • How it Works
  • Required Access
  • Prerequisites
  • Support
  • Procedure
  • Remove a PagerDuty Integration

You can configure Atlas to send alerts from your project to your PagerDuty dashboard. With PagerDuty integration, you can:

  • Record incidents and notify on-call responders based on Atlas alerts.

  • Automatically resolve incidents in PagerDuty when an Atlas alert is closed with bidirectional synchronization.

How it Works

With a PagerDuty integration, you can send Atlas cluster event data to PagerDuty when Atlas 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 Atlas alert has been resolved, PagerDuty resolves the incident.

Required Access

To create, update, or remove a PagerDuty integration, you must have Project Owner access to the project. Users with Organization Owner access must add themselves to the project as a Project Owner.

Prerequisites

To integrate Atlas 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/.

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.

Support

If you need help with your Atlas PagerDuty integration, contact MongoDB Support.

Procedure

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.

To integrate with PagerDuty using the Atlas UI, navigate to the PagerDuty integration card:

1

In Atlas, go to the Project Integrations page.

  1. If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. Next to the Projects menu, expand the Options menu, then click Integrations.

    The Project Integrations page displays.

2

Start linking PagerDuty to your project.

Click Configure for the PagerDuty integration card. You can configure PagerDuty with either your PagerDuty credentials or your PagerDuty API key.

You can configure an Atlas integration with PagerDuty in two ways:

  • By signing into PagerDuty from the Atlas Project Integrations page, or

  • By providing a valid Integration Key.

Sign into PagerDuty

1

Click Sign in with PagerDuty.

You are redirected to PagerDuty.

2

Log into PagerDuty using your PagerDuty credentials.

3

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 Atlas project and displays a PagerDuty Configuration modal.

4

Select a default service to integrate with MongoDB.

From the PagerDuty Configuration modal, select one default service to integrate. Atlas automatically provides an integration key.

5

(Optional) Click Test Integration to confirm that your configuration is valid.

When you click Test Integration, the PagerDuty configuration modal displays a banner with a success or failure message.

6

Click Activate to integrate PagerDuty with Atlas.

When you click Activate, PagerDuty validates your configuration.

Provide an Integration Key

1

Enter your Integration Key.

2

(Optional) Click Test Integration to confirm that your key is valid.

When you click Test Integration, the PagerDuty configuration modal displays a banner with a success or failure message.

3

Click Activate to integrate PagerDuty with Atlas.

When you click Activate, PagerDuty validates your Integration Key.

Important

If the Integration Key that you specify is invalid, the PagerDuty Events API doesn't fail and the Test Integration button might falsely indicate a successful integration. To confirm that your integration is successful, Atlas sends an initial alert. Check your PagerDuty dashboard for an initial incident created by that Atlas alert.

Remove a PagerDuty 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.

Tip

See: Related Links

To remove the PagerDuty integration from your Atlas project using the Atlas UI, click Remove on the PagerDuty card in your Atlas project's Project Integrations.

Back

Microsoft Teams

Next

Prometheus