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.

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.

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!

Step 1: Create an API Key

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

1. Create a new API Key: On the API Access Keys page, click the button labeled Create New API Key.

   

2. Input Description: Provide a description for the API key and select the checkbox if you need a Read-only API Key. This will determine the level of access your API key has. The other option is Full access.

   

   After that, click on Create Key to create your API Key.

3. After creating your API key, you’ll have a table containing the following parameters:

   

   • ID: A unique identifier associated with the API key.
   • API Key: This is the unique alphanumeric string generated by PagerDuty when you create a new API key.
   • Description: This field contains the name or a brief description you gave when creating the key.
   • Created: This parameter shows the exact date, time, and the name of the person or system that generated the API key.
   • API Version: Indicates the version of the PagerDuty API that the key is using.
   • Access Level: Specifies the level of access the API key provides. This could range from read-only permissions to complete control over incidents, users, and other PagerDuty operations.
   • Disabled: This field indicates whether the API key is currently disabled. If a key is disabled, it cannot be used for authentication until it is re-enabled.

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

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.

   

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

   

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

3. Enter credentials: Provide the following 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:

   

Step 3: 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.

   

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.

   

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.

   

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).

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

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

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

   

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

   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.

   

10. Your session analysis is displayed