The goal of the below walkthrough is to establish an integration with PagerDuty, launching automatic playbooks every time an incident is either created or updated (resolved, for example). Such playbooks can perform automatic enrichment/triage of the incident, as well as orchestrate communications/activities around it (acknowledge it, re-assign it, open dedicated Slack channels, open dedicated follow-up Jira tickets, etc...)
PagerDuty + StackPulse Integration Benefits
- Speed up incident resolution with automated playbooks triggered by PagerDuty incident events.
- Automate incident acknowledgements, updates and status changes
- Standardize the incident response process with code-based, shareable playbooks
- Use PagerDuty on call schedules in playbooks to streamline communication and escalation during incidents.
How it Works
- PagerDuty incident events can trigger the execution of one or multiple StackPulse automated playbooks.
- From within a StackPulse playbook, steps which utilize PagerDuty's API can automatically acknowledge or resolve a PagerDuty incident. In addition, StackPulse steps can get the current or future on-call list to be used in additional steps (e.g. notify the on-call regarding PlayBook execution status).
- Configuring the StackPulse-PagerDuty integration requires a PagerDuty API token. You must be a PagerDuty Admin, Global Admin or Account Owner to generate this token. If you do not have this access, please reach out to an Admin or Account Owner within your organization to configure the integration.
- You must have an active StackPulse account.
If you need help with this integration, please contact email@example.com.
- In the StackPulse Administration Portal navigate to Integrations and choose the PagerDuty card.
- Click on Add, choose a dedicated name for the integration and copy the generated WebHook URL for use in the future steps.
For each service defined in PagerDuty that is expected to trigger automatic playbooks via this PagerDuty-StackPulse integration:
- Navigate to Configuration → Services, then click the name of the service you want to add a webhook to.
- Select the Integrations tab, under Extensions and Add-Ons, click Add or manage extensions for this service and then click New Extension.
- For the Extension Type select your webhook type or Generic V2 Webhook.
- Enter a Name for your webhook.
- Enter your generated WebHook URL (step 2 in the StackPulse section) in the Details field.
- Click Save.
To perform PagerDuty actions using PagerDuty steps in a StackPulse playbook you will need to create an API token:
- Go to Apps and Add-Ons → API Access and click Create New API Key.
- Enter a Description that will help you identify the key later on. Keep the Read-Only option unchecked.
- Click Create Key.
- A unique API key will be generated. Copy it for use in the next steps.
BACK IN STACKPULSE
- In the StackPulse Administration Portal navigate to Integrations and choose the PagerDuty API Keys card under the Secrets section.
- Click Add.
- Then, fill in Integration Name with a unique integration name that you can reference from playbooks (e.g. pagerduty-token-team1).
- Fill in API Key with the API key (generated in step 4 of the PagerDuty section above).
- Click Save.
At this point, you can either (a) receive PagerDuty alerts that will trigger a StackPulse playbook to auto-handle the incident and/or (b) leverage StackPulse playbook steps to close the loop against PagerDuty (i.e. acknowledge or resolve).
How to Uninstall
- In the StackPulse Administration Portal navigate to Integrations and choose the PagerDuty card under the Monitoring section.
- Click View.
- Highlight the integration set up in step 2 of the StackPulse section in the installation steps.
- Click on the trash bin icon that appears on the right hand side to delete the integration.
- Navigate to Integrations and choose the PagerDuty API Keys card.
- Click View.
- Highlight the PagerDuty API key you wish to remove.
- Click on the trash bin icon that appears on the right hand side to delete the key.