Creating PagerDuty integrations
A PagerDuty integration provides event data that is analyzed and processed into alerts. An incident is generated, based on an alert severity, and published to your incident viewer interface with insights into potential issues that impact operations.
Contextual alerts can be grouped into an incident by using temporal, topological, and scope correlation methods. For more information, see About events, alerts, and incidents.
The source attribute in the event is used to get the entity information. The entity information is used for the application resolution and the event grouping. For more information, see Application incidents, and Managing incidents and alerts.
For more information about working with PagerDuty integrations, see the following sections:
- Prerequisites
- Creating PagerDuty integrations
- Enabling PagerDuty integrations
- Editing PagerDuty integrations
- Deleting PagerDuty integrations
For more information about HTTP headers for the various credential types, see HTTP headers for credential types.
Prerequisites
PagerDuty integration uses the log anomaly detection pipeline.
Therefore, you must enable the logAnomalyDetection property in the Cloud Pak for AIOps installation CR before you set up PagerDuty integration. For more information on how to enable the property for different deployment types, see
Incremental adoption.
To check if log anomaly detection is enabled, complete the following steps:
-
Get the name of the installation by running the following command:
oc get installation -
Get the CR information by running the following command:
oc get installation <name of installation> -o yaml -
In the CR, check under
spec.pakModulesiflogAnomalyDetection.enabledis set totrue.
Creating PagerDuty integrations
To create a PagerDuty integration, complete the following steps:
-
Log in to IBM Cloud Pak for AIOps console.
-
Expand the navigation menu (four horizontal bars), then click Define > Integrations.
-
On the Integrations page, click Add integration.
-
From the list of available integrations, find and click the PagerDuty tile.
Note: If you do not immediately see the integration that you want to create, you can filter the tiles by type of integration. Click the type of integration that you want in the Category section.
-
On the side-panel, review the instructions and when ready to continue, click Get started.
Figure. Configure Pagerduty integration -
On the Add integration page, define the general integration details:
-
Name: The display name of your integration.
-
Description: An optional description for the integration.
-
API key: The integration token for your PagerDuty instance.
-
Service IDs: An optional comma-separated list of PagerDuty service IDs. The service ID can be obtained from the PagerDuty URL. If you view a specific service, the PagerDuty URL might be something like the following URL: https://xyz.pagerduty.com/service-directory/P4FY6G2 For this example, the service ID could be
P4FY6G2.
Figure. Create Pagerduty integration -
Team IDs: An optional comma-separated list of PagerDuty team IDs. If you view a specific team, the PagerDuty URL might be something like the following URL: https://ibm.pagerduty.com/teams/PV429MG In this example, the team ID is
PV429MG. -
Base parallelism: It is recommended to use a higher value than 1 so that you can process data in parallel. In a small environment the available flinks slots is 16 and for a large environment, the maximum available slots is 32.
-
Sampling rate: The rate at which data is pulled from live source (in seconds). The default value is
60. -
Data flow: Set the toggle to 'On' to enable event data from PagerDuty to flow to IBM Cloud Pak for AIOps. For more information about enabling your integration, see Enabling PagerDuty integrations.
Note: When the
body.cef\_detailsattribute is not present in the raw data from PagerDuty, there is no way to extract the entity and assign it to theresourceattribute in the event input and the event cannot be associated with an application.
You can test your integration by clicking Test connection.
Note: PagerDuty mappings are the default mappings for IBM Cloud Pak for AIOps's standard fields for events.
-
-
Click Done.
You created a PagerDuty integration in your instance.
{: caption="Figure. Pagerduty integration running" caption-side="bottom"}
To create more integrations, see Configuring Integrations.
For more information about working with the insights provided by your integrations, see Managing incidents and alerts.
Enabling and disabling PagerDuty integrations
If you didn't enable your data collection during creation, you can enable your integration afterward. You can also disable a previously enabled integration the same way. To enable or disable a created integration, complete the following steps:
-
Log in to IBM Cloud Pak for AIOps console.
-
Expand the navigation menu (four horizontal bars), then click Define > Integrations.
-
On the Manage integrations tab of the Integrations page, click the PagerDuty integration type.
-
Click the integration that you want to enable or disable.
-
Set Data collection to On or Off to enable or disable log data collection. Disabling data collection for an integration does not delete the integration.
You enabled or disabled your integration. For more information about deleting a integration, see Deleting PagerDuty integrations.
Editing PagerDuty integrations
After you create your integration, your can edit the integration. To edit a integration, complete the following steps:
-
Log in to IBM Cloud Pak for AIOps console.
-
Expand the navigation menu (four horizontal bars), then click Define > Integrations.
-
Click the PagerDuty integration type on the Manage integrations tab of the Integrations page.
-
On the PagerDuty integrations page, click the name of the integration that you want to edit. Alternatively, you can click the options menu (three vertical dots) for the integration and click Edit. The integration configuration opens.
Figure. Edit Pagerduty integration -
Edit your integration. Click Next to go through the integration configurationn pages. Click Save when you are done editing.
You edited your integration. If you did not previously enabled or disabled your application, you can enable or disable the integration directly from the interface. For more information about enabling and disabling your integration, see Enabling and disabling PagerDuty integrations. For more information about deleting a integration, see Deleting PagerDuty integrations.
Deleting PagerDuty integrations
If you no longer need your PagerDuty integration and want to not only disable it, but delete it entirely, you can delete the integration from the console.
Note: You must disable data collection before you delete your integration. For more information about disabling data collection, see Enabling and disabling PagerDuty integrations.
To delete a integration, complete the following steps:
-
Log in to IBM Cloud Pak for AIOps console.
-
Expand the navigation menu (four horizontal bars), then click Define > Integrations.
-
Click the PagerDuty integration type on the Manage integrations tab of the Integrations page.
-
On the PagerDuty integrations page, click the options menu (three vertical dots) for the integration that you want to delete and click Delete.
-
Enter the name of the integration to confirm that you want to delete your integration. Then, click Delete.
Your integration is deleted.