PagerDuty Integration

This guide goes through the steps necessary to integrate Backtrace with PagerDuty. Setting up integration with the PagerDuty incident management system requires a valid PagerDuty API Service Key.

Main steps for setting up PagerDuty:

  1. Generate an API Service Key
  2. Integration

Generate an API Service Key

Within PagerDuty, click on the Configuration menu at the top, then select Services. Select the API Service (create it using the Add New Service button if it doesn't yet exist), then click the Integrations tab. Click the green New Integration button:

PagerDuty

Then in the Add an Integration screen, pick an Integration Name, select "Use our API directly", then click Add Integration:

PagerDuty

Once this is done, the API Service Integrations tab will list the new integration along with the Integration Key. You'll use this key as the service_key setting in the Coronerd Configuration below.

Integration


To set up the integration, first go to the Configuration page within the Web Console:

Config


Next, select the project you want to add a integration for:

Select Project


Then click Integrations in the left-hand menu, then Create a New Integration on the right, and pick the integration:

Create Integration


These are the settings that you can configure for your PagerDuty integration:

Setting Required Description
Service Key Yes This is the "integration key" listed on a service's "Integrations" page (see Generate an API Service Key above)
Subject No A descriptive subject of the event - used in SMS messages and alert emails. The integration will replace the macros {{project}}, {{group_prefix}}, {{classifiers}}, {{frames}}, and {{application}} with information from the crash. Defaults to "BACKTRACE" if not set.

The integration will automatically populate the following in the PagerDuty Trigger API:

Setting Description
event_type Set to "trigger"
description Set to the "subject" above
incident_key Set to the group ID. Used by PagerDuty to to prevent deduplication of alerts. If there's already an open incident with this group ID, this one will be appended to it rather than opening a new one.
client Set to "Backtrace Coronerd"
client_url Set to the URL for the group in the coroner console.

For more information, see: PagerDuty Trigger Events Documentation

PagerDuty


Next: After filling in the integration-specific settings, proceed to Common Settings to finish configuring the integration.