IBM Cloud Docs
Configuring PagerDuty

Configuring PagerDuty

PagerDuty integrates data from multiple monitoring systems into a single view. When a problem occurs, PagerDuty ensures that the team member who is best able to fix it at the time is notified. If the team member does not respond to the problem, escalations can be configured to route it to secondary representatives or operations managers.

You can now distribute event notifications by using the Event Notifications tool integration. IBM Cloud® Event Notifications is the preferred method for distributing notifications to PagerDuty and other communication channels such as Slack, email, SMS, push notifications, webhook, Microsoft® Teams, ServiceNow, and IBM Cloud Functions. For more information about using Event Notifications, see Enabling event notifications for toolchains.

Client bespoke toolchain events generated by the POST /toolchains/{toolchain_id}/events API are not sent to the PagerDuty tool integration. Bespoke toolchain events are sent only to IBM Cloud® Event Notifications.

Configure PagerDuty to send notifications when pipeline stage failures occur so that you can fix problems faster and reduce downtime:

  1. If you are configuring this tool integration as you are creating the toolchain, in the Configurable Integrations section, click PagerDuty.

  2. If you have a toolchain and are adding this tool integration to it, from the IBM Cloud console, click the Menu icon hamburger icon > Platform Automation > Toolchains. On the Toolchains page, click the toolchain to open its Overview page. Alternatively, on your app's Overview page, on the Continuous delivery card, click View toolchain. Then, click Overview.

    a. Click Add tool.

    b. In the Tool Integrations section, click PagerDuty.

  3. If you want to integrate PagerDuty at the account level by using an API key, click Account:

    a. Type the API access key for your PagerDuty account. If you don't have a PagerDuty account, register for one. For instructions to find the key, see Generating an API Key.

    b. Type the name of your PagerDuty service.

    c. Type the email address for the primary PagerDuty contact.

    d. Type the phone number for the primary PagerDuty contact.

  4. If you want to integrate PagerDuty at the service level by using an integration key, click Service:

    a. Type the URL for the PagerDuty service that you want to post alerts to.

    b. Type your PagerDuty integration key. You can find your key or create a key in the Integrations section of your PagerDuty service page.

  5. Click Create Integration.

  6. On your Toolchain's Overview page, on the Third-Party tools card, click PagerDuty to go to pagerduty.com. You can view the events that are associated with the PagerDuty service that you specified when you configured this tool integration for your toolchain.

Configuring PagerDuty by using the API

The PagerDuty tool integration supports the following configuration parameters that you can use with the Toolchain HTTP API and SDKs when you create, read, and update tool integrations.

You must specify the tool_type_id property in the request body with the pagerduty value.

PagerDuty tool integration parameters
Parameter Usage Type Terraform argument Description
service_id optional, updatable String service_id The service ID of the PagerDuty service.
service_key optional, updatable Password service_key The PagerDuty service tool integration key. You can find or create this key in the Integrations section of the PagerDuty service page.
service_url optional, updatable String service_url The URL of the PagerDuty service to post alerts to.