Last updated Apr 21, 2024

Integrate Compass with PagerDuty

What is PagerDuty?

Through its SaaS-based platform, PagerDuty empowers developers, DevOps, IT operations and business leaders to prevent and resolve business-impacting incidents for exceptional customer experience. When revenue and brand reputation depends on customer satisfaction, PagerDuty arms organizations with the insight to proactively manage events that may impact customers across their IT environment. With hundreds of native integrations, on-call scheduling and escalations, machine learning, business-wide response orchestration, analytics, and much more, PagerDuty gets the right data in the hands of the right people in real time, every time.

Compass currently supports PagerDuty as a tool to:

  • display on-call information
  • visualize incident events on the activity feed
  • provide metrics around incidents

Integrate Compass with PagerDuty

To integrate Compass with PagerDuty, you must first install the PagerDuty app in Compass. Then, you must create, or use an existing, PagerDuty API key (make sure it's a "full access" key) to connect Compass to the PagerDuty account to finish setup.

When you integrate an app with Compass, other Compass users can view events and metrics data sent from the app to Compass, even if they don't have access to that data in the underlying app. For example, when you integrate Bitbucket with Compass, someone who doesn't have access to a repository can see the events and metrics related to that repository in Compass. The same applies to data sent from this app to Compass.

Before you begin

Perform the integration

Learn more about PagerDuty API keys

Integrate Compass with PagerDuty:

  1. Select Apps from the top navigation bar in Compass.
  2. Select Install on the PagerDuty app card. This installs the PagerDuty app in Compass.
  3. Select Configure on the PagerDuty app card.
  4. Authorize the PagerDuty app to access Compass on your behalf if you haven't previously done so.
  5. Select the service region of your PagerDuty account.
  6. Enter the API key from PagerDuty. Do not check the "Read-only API key" box when creating a new API key. The API key should have the "Full access" access level.
  7. Select Connect account.

Add on-call and incident information from PagerDuty to a component

With the PagerDuty app Compass you can associate a PagerDuty service with a Compass component to show on-call and incident information directly in Compass. Compass evaluates the escalation policy associated with the specified service to render the on-call information. It will also watch for incidents belonging to the associated PagerDuty service to plot those on the activity feed and calculate incident-related metrics.

  1. In Compass, navigate to a component you want to connect to your PagerDuty on-call information. On the component’s overview page, you’ll see the on-call section on the right side of the component’s details.
  2. Select + Add on-call schedule
  3. Search for a service in PagerDuty by name, or paste a link to your PagerDuty service.
  4. Optionally, enter link text to be displayed as the card’s title (Instead of ‘PagerDuty’ as the card title).
  5. Select Add.

Your on-call information and metrics are displayed and updated from PagerDuty. If for some reason you encounter an error after adding a PagerDuty service, make sure you entered the right type of link (e.g. https://yourcompany.pagerduty.com/service-directory/POG79I7).

View incident events from PagerDuty

First be sure to complete the Add on-call and incident information from PagerDuty to a component section.

  1. In Compass, navigate to a component you want to view incident events for.
  2. Select Activity on the left side of the component's details.
  3. See recent incidents on the Timeline or List views of the activity feed for the component or dependencies.

See metrics about incident events from PagerDuty

First be sure to complete the Add on-call and incident information from PagerDuty to a component section.

  1. In Compass, navigate to a component you want to view incident events for.
  2. View the metrics section of the component's details.

Supported metrics: Learn more about Compass metrics.

MetricDescriptionHow it's calculated
Incident CountThe number of incidents opened in the last 28 days.Incident events from associated PagerDuty service.
MTTRMTTR (mean time to resolve) is the average time it takes to fully resolve a failure, as measured from when an incident occurs (making the component dysfunctional) to when the component becomes fully functional again, measured over the last 10 incidents.Incident events from associated PagerDuty service.

If you do not see metrics updating it could be that you have not had any incidents recently (hooray!). Make sure you also added the correct PagerDuty service link to the component.

Remove on-call and incident information from PagerDuty to a component

  1. In Compass, navigate to a component you want to remove your PagerDuty on-call information from. On the component’s details page, you’ll see the on-call section on the right side of the component’s details.
  2. Select the 'X' icon next to the on-call link information you want to remove.
  3. Select Remove in the dialogue that opens to confirm.

The on-call information no longer appears in the on-call card.

Disconnect the PagerDuty account connected with Compass

Disconnecting your PagerDuty account means on-call and incident information will no longer be displayed for your components.

Before you begin

  • Ensure that you’re an admin on your Compass instance.

Disconnect the PagerDuty account

To disconnect a PagerDuty account from Compass:

  1. In Compass, from the top navigation bar, select Apps.
  2. Select Configure on the PagerDuty app card.
  3. Select Disconnect. The PagerDuty account is disconnected from Compass and the page refreshes to its initial state with no account connected.

Uninstall the PagerDuty app from Compass

If you no longer want to use the PagerDuty app from Compass you can uninstall it.

Before you begin

  • Ensure that you’re an admin on your Compass instance.

Uninstall the PagerDuty app

To uninstall the PagerDuty app from Compass:

  1. In Compass, from the top navigation bar, select Apps.
  2. Select Configure on the PagerDuty app card.
  3. Select Uninstall on the PagerDuty app card. The PagerDuty app uninstalls from Compass.

Rate this page: