PagerDuty Integration
Benefits of PagerDuty Integration
- Notifies on-call operations team members whenever an early warning or problem signal is generated by HEAL
- Creates an incident ticket with details about the application, component and problem metrics
- Provides a permalink to the HEAL signals page for accessing the root-cause analysis, deep-dive into the problem and related early warnings or problems
How it Works
HEAL generates an early warning or problem signal when it notices abnormal application behavior and when end-users start getting impacted. This signal triggers an incident and alert in PagerDuty through the integrated PagerDuty plugin.
Requirements
PagerDuty integration requires installing the PagerDuty plugin on the HEAL server and configuring the plugin to connect to the PagerDuty instance. You need to have a PagerDuty account for the integration to work.
Support
Integration Walkthrough
In PagerDuty
HEAL is integrated with PagerDuty using the latter’s events API v2. This integration requires you to have a PagerDuty service configured. If you already have a service configured in PagerDuty go to section “Configuring existing service”.
Creating New Service
1. To create a new service in PagerDuty, refer to their documentation here. Select the option “Use our API directly” while creating the service.
2. On the Service page click on Integrations and copy the integration key to be used later.
Configuring Existing Service
1. Go to the Service page.
2. Click on Integrations.
3. If an events API v2 integration exists, copy the integration key to be used later.
4. If an events API v2 integration does not exist:
a. Follow the PagerDuty documentation here to add an integration. Select the option “Use our API directly” while creating the integration.
b. Copy the integration key to be used later.
In HEAL Server
Add the integration key obtained from PagerDuty as explained above to the PagerDuty plugin configuration.
1. Navigate to <install directory>/Appsone_service/a1eventhandler/config folder.
2. Edit the file plugin-details.json to enter the integration key in the “PagerDuty_Integration_Key” field.
3. Save the file and restart the HEAL event handler service for the changes to take effect.
As soon as this is done, the PagerDuty plugin should start sending events to PagerDuty so that incidents get created. This would indicate a successful deployment of the PagerDuty plugin.
How to Uninstall
To stop HEAL from creating incident tickets and alerts in PagerDuty, remove the PagerDuty plugin from the HEAL server.
1. Stop the HEAL event handler service.
2. Delete the PagerDuty plugin from the <plugin> directory.
3. Start the HEAL event handler service.