Configure a PagerDuty integration

You can configure the Red Hat Hybrid Cloud Console to send event notifications to a PagerDuty service. The PagerDuty integration supports events from all Hybrid Cloud Console services.

When an issue in the Hybrid Cloud Console is detected, PagerDuty automatically notifies the appropriate team members through phone calls, SMS, emails, or push notifications. PagerDuty uses scheduling to ensure team members are alerted only during their designated times. You can create escalation policies to escalate an issue to another team member if the first on-call team member does not respond to the alert. PagerDuty also provides incident management features for a coordinated response to resolve issues.

If you have any issues with the Hybrid Cloud Console integration with PagerDuty, contact Red Hat for support. To open a Red Hat support case directly from the Hybrid Cloud Console:

  1. Click Help (the ? icon) to open the help panel.
  2. Select the My support cases tab.
  3. Click Open a support case and add information about the issue.

PagerDuty will not provide troubleshooting. The Hybrid Cloud Console integration with PagerDuty is fully supported by Red Hat.

Create a PagerDuty service
Copy link

Create a PagerDuty service that you will integrate with the Hybrid Cloud Console so that your organization will receive notifications about the Hybrid Cloud Console.

Before you begin
Copy link

  • You are logged in to PagerDuty.
  • At least one PagerDuty team exists.
Note
If you already have a PagerDuty service that you want to integrate with the Hybrid Cloud Console, see Generate an integration key for an existing PagerDuty service.

Procedure
Copy link

  1. On the PagerDuty home page, click Services.
  2. Click New Service. The Create a Service wizard opens.
  3. Enter a name and description for the new service, for example Red Hat PagerDuty Service, and then click Next.
  4. Either select an existing escalation policy, or generate a new one, and then click Next.
  5. On the Reduce Noise screen, make any desired selection and then click Next.
  6. On the Create a Service screen, select the Events API V2 integration and then click Create Service.
  7. If necessary, on the Integrations page, click the arrow next to Events API V2 to expand the panel.
  8. Copy the integration key next to Events API v2 Overview. You will use this key to integrate the service with the Hybrid Cloud Console.

What to do next
Copy link

Generate an integration key for an existing PagerDuty service
Copy link

You can add an integration key to an existing PagerDuty service so that you can integrate the service with the Hybrid Cloud Console. After you integrate the service, the Hybrid Cloud Console will send notifications to that PagerDuty service.

Before you begin
Copy link

  • You are logged in to PagerDuty.
  • At least one PagerDuty service exists.
  • At least one PagerDuty team exists.
Note
For information about creating a new PagerDuty service to integrate with the Hybrid Cloud Console, see Create a PagerDuty service.

Procedure
Copy link

  1. On the PagerDuty home page, click Services.
  2. Select the service that you want to generate the integration key for.
  3. Select the Integrations tab and click Add another integration.
  4. On the Add Integrations screen, select the Events API V2 integration and then click Add.
  5. If necessary, click the arrow next to Events API V2 to expand the panel.
  6. Copy the integration key next to Events API v2 Overview. You will use this key to integrate the service with the Hybrid Cloud Console.

What to do next
Copy link

Add a PagerDuty account as an integration
Copy link

You can connect your PagerDuty account to the Red Hat Hybrid Cloud Console as an integration so that the Hybrid Cloud Console sends event notifications to a PagerDuty service through phone calls, SMS, emails, or push notifications.

Before you begin
Copy link

Procedure
Copy link

  1. Go to Settings > Integrations.
  2. Select the Reporting & Automation tab.
  3. Click Add integration to open the Add integration wizard. If this is the first integration you are adding, skip this step.
  4. Select PagerDuty, and then click Next.
  5. Enter a descriptive name for the integration, for example, PagerDuty Integration.
  6. Enter the integration key for the PagerDuty account you are integrating. See Create a PagerDuty service for information about creating an integration key.
  7. Specify an alert severity.
  8. Click Next.
  9. Optional: Associate events with the integration. Doing this automatically creates a behavior group.
    Note
    You can skip this step and associate the event types later.
    1. Select a product family, for example OpenShift, Red Hat Enterprise Linux, or Console.
    2. Select the event types you would like your integration to react to.
  10. To enable the integration, review the integration details and click Submit.
  11. Refresh the Integrations page to show the PagerDuty integration in the Integrations > Reporting & Automation list. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the Hybrid Cloud Console.

What to do next
Copy link

Verify your integration:

Create a test notification to confirm you have correctly connected PagerDuty to the Hybrid Cloud Console:

  1. Go to the Integrations page, and select the Reporting & Automation tab.
  2. Confirm that your PagerDuty integration is listed and the status is Ready.
  3. Next to your PagerDuty integration, click the options icon (⋮) and click Test.
  4. In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
  5. Open your PagerDuty instance and check for the message sent from the Hybrid Cloud Console.
  6. In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: PagerDuty event is listed with a green label.

Create the behavior group for the PagerDuty integration
Copy link

A behavior group defines which notifications will be sent to external services such as PagerDuty when a specific event is received by the notifications service. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group.

Before you begin
Copy link

  • You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions. Note
    You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see ../get-started/access-hcc.dita#finding-login.
  • You have configured the PagerDuty integration.

Procedure
Copy link

  1. In the Hybrid Cloud Console, navigate to Settings > Notifications.
  2. Under Notifications, select Configure Events.
  3. Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, or OpenShift.
  4. Click the Behavior Groups tab.
  5. Click Create new group to open the Create behavior group wizard.
  6. Type a name for the behavior group and click Next.
  7. In the Actions and Recipients step, select Integration: PagerDuty from the Actions drop-down list.
  8. From the Recipient drop-down list, select the name of the integration you created (for example, PagerDuty Integration) and click Next.
  9. In the Associate event types step, select one or more events for which you want to send notifications (for example, Policies: Policy triggered) and click Next.
  10. Review your behavior group settings and click Finish. The new behavior group is listed on the Notifications page.

What to do next
Copy link

Verify your integration:

  1. Create an event that will trigger a Hybrid Cloud Console notification. For example, run insights-client on a system that will trigger a policy event.
  2. Wait a few minutes, and then navigate to PagerDuty.
  3. In your PagerDuty account, check for notifications from the Hybrid Cloud Console.
  4. In the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: PagerDuty.
    • If the label is green, the notification succeeded.
    • If the label is red, the integration might need to be adjusted.
  5. If the integration is not working as expected, verify that the Events API v2 integration key was properly created in PagerDuty, and that the correct incoming integration key is added in the Hybrid Cloud Console integration configuration. Note
    See ../troubleshoot/troubleshoot-notif-failures.dita#proc-troubleshoot in the notifications documentation for more details.