PagerDuty

PagerDuty is an incident management platform that helps IT and DevOps teams quickly monitor and resolve critical issues.

Integrating a PagerDuty connection on your Hawkeye dashboard enhances our incident response capabilities by allowing you to receive and manage alerts in real-time.

Note

For each step, we’ve created a short demo walkthrough and a step-by-step guide. You can check out the demo for a visual guide to setting up your PagerDuty connection!

To set up a PagerDuty connection, you must create an API key, which you’ll need as a credential. The following steps will guide you in creating one.

Step 1: Create an API Key

Permission Required

API key must be from a user that has write access to create status updates on incidents and add notes to incidents.

Fig.1 - A walkthrough of how to create an API key for PagerDuty connection

Sign in to your PagerDuty dashboard and follow the instructions below:

1. Navigate to My Profile: On the top right corner of your dashboard, click the profile icon, then navigate to My Profile.

   

   Fig.2 - PagerDuty profile

2. Locate User Settings: In the Profile page, click on User settings tab.

   

   Fig.3 - PagerDuty user settings

3. Create a new API User Token: On the User Settings page, click the button labeled Create API User Token.

   

   Fig.4 - PagerDuty create API user token

4. Input Description: Provide a description for the API token and click the Create token button.

   

   Fig.5 - PagerDuty user token description

5. Securely copy and save your new API User Token.

   

   Fig.6 - Copy and save API user token

Note

Please save your API key somewhere safe. You won’t be able to retrieve it after creating it.

Step 2: Add PagerDuty connection to Hawkeye

Fig.7 - A walkthrough of how to add PagerDuty connection to Hawkeye

With your API Key ready, navigate to the Hawkeye dashboard and follow these next steps:

1. Navigate to the connections tab: On the dashboard, navigate to the Connections section and select the New Connection card.

   

   Fig.8 - Connection dashboard page

2. Select PagerDuty connection: Select PagerDuty from the list of available connections.

   

   Fig.9 - PagerDuty connection page

   After this, click on the Next button in the top right corner.

3. Enter credentials: Provide the following credentials:

   

   Fig.10 - Enter PagerDuty credentials

   • Name: This is the name of the connection you’re about to create.
   • Description: This gives an overview of the connection.
   • API Key: This is the PagerDuty API Key you created in Step 1.

   Verify all the credentials are correct and click the Save button at the top right corner.

4. Confirm that the PagerDuty connection was successfully created. If it did, you’ll see the connection card display like this on the Connections tab:

   

   Fig.11 - Confirm PagerDuty connection

Step 3: Add PagerDuty connection to Project

Fig.12 - A walkthrough of hoow to add PagerDuty connection to Project

Note

While adding the PagerDuty connection, you can enable automated session by checking the Created automated session box. You can enable this while creating a new project or while editing an existing project.

The following steps will guide you on how to add your PagerDuty connection to projects.

1. Navigate to the Projects Tab: In the Hawkeye dashboard, go to the Projects section and click on New project.

   

   Fig.13 - Project dashboard page

2. Enter project details: In the new project page, enter the following details:

   • Project name: Give your project a descriptive name.
   • Project description: Enter a detailed description for your project.
   • Color: Select a color you want to identify your project with.

   

   Fig.13 - Pager project details

3. Select connection: From the list of connections that appear, select PagerDuty. In the PagerDuty accordion;

   • Check the Create automated session box to enable automated session
   • Select the Treshold for priority: High, High & Medium or All

   Click Next when done.

   

   Fig.14 - PagerDuty project connection

4. Enter project Instructions: State precisely, the details of your project, and what resources you expect to monitor or ignore. (This helps Hawkeye understand the context of your project and to deliver better and more relevant analysis).

   Fig.15 - PagerDuty project instructions

5. Navigate back to Project: After your Project has been created successfully, navigate back to Projects page.

   Fig.16 - PagerDuty back to Projects

6. View new project: In the list of Projects in the Projects page, you’ll find your newly created Project with PagerDuty connection.

   Fig.17 - PagerDuty project ready

7. Start Session: If project status is Ready, click to start a new session.

   

   Fig.18 - PagerDuty Session

8. Sessions Interface: The following tabs on the session interface, will help you navigate your alerts.

   Fig.18 - PagerDuty Session interface

   1. Open tab displays only the alerts that are yet to be resolved.
   2. Resolved tab displays only the alerts that have been resolved.
   3. The All tab displays all both open and resolved alerts.
   4. This logo tabs display the services that are connected to automated sessions.
   5. You can view all the connected services using the last All tab.

9. Enter a prompt: Enter a question regarding your services or alerts to start a session.

   

   Fig.19 - PagerDuty Session prompt

10. Your session analysis is displayed

    

    Fig.20 - PagerDuty Session analysis