Hawkeye is a network performance monitoring application used to find issues before they impact the end-user experience by continuously monitoring key network paths and services. This guide shows you how to integrate Hawkeye with PagerDuty to create PagerDuty incidents by sending emails containing test results and KPI’s from Hawkeye.
- Go to the Services menu and select Service Directory.
- On the Service Directory page:
- If you are creating a new service for your integration, click +New Service.
- If you are adding your integration to an existing service, click the name of the service you want to add the integration to. Then click the Integrations tab and click the Add an integration to this service link.
- Select Integrate via email from the Integration Type menu
- Enter an Integration Name. If you are creating a new service for your integration, in General Settings, enter a Name for your new service. Then, in Incident Settings, specify the Escalation Policy, Notification Urgency, and Incident Behavior for your new service.
- An integration email address will auto-populate in the Integration Email field. The text for your email address will be based on the name you give this integration in General Settings. If you would like your email address to contain different text, you may edit it. This email address is the integration key for this integration.
- Click the Add Service or Add Integration button to save your new integration. You will be redirected to the Integrations page for your service.
- In the Actions menu, select Edit.
- In the Email Management section, select Open a new alert for each trigger email and click the Save Changes button. You will be redirected to the Integrations page for your service.
- Copy the integration email address to your clipboard and point your monitoring system to the integration email address. PagerDuty will open and trigger an incident when it receives an email to this integration address.
- Configure your email preferences by navigating to the Administration menu and selecting Preferences. Select the Email tab, enter the SMTP configuration parameters, and click Save.
- In the Test Execution menu, when configuring a test, click Show Alarm Options, choose the alarm conditions in the Set Alarm On section (Status Change, Failed, Error).
- Select email in Alarm Types and input the Integration Email you configured in PagerDuty. Then, click Start Test.
- If the alarm conditions for a test are triggered, an email will be sent to the Integration Email. You can view emails Hawkeye has sent by navigating to the Alarms menu and selecting Generated Alarms List. Seeing “yes” in the Alarm Sent column indicates an email was sent.
- Email alarms to PagerDuty can also be added to any test template. To set this up, navigate to the Probe Management menu and select Test Templates.
- Click the Alarms tab, then select the alarm conditions (Status Change, Failed, Error).
- Select Email and input the Integration Email you configured in PagerDuty, and click Save.
Frequently Asked Questions
Can I change the test conditions that trigger a Hawkeye email alarm to PagerDuty?
Yes! Email alarms can be enabled for various conditions. For example, when test KPI thresholds are not met, when tests could not be started, when tests start but did not execute properly. Scheduled tests can also send alerts when the current test did not return with the same result as the prior test.
Can I customise the title and contents of the Hawkeye email alarm?
No. Currently the Hawkeye email alarm to PagerDuty has a pre-defined title and test results format. This is why it’s important to configure Integration Email Management to open a new alert for each email alarm. This ensures Hawkeye email alarms are not de-duped by PagerDuty.
What happens if the Hawkeye email alarm can’t be sent to PagerDuty?
Hawkeye attempts to send the email alarms based on the Administration Preferences Max Email Attempts parameter. When an email cannot be sent, a status other than “yes” will be shown in the Alarm Sent column of the Generated Alarms List. No additional retries will be attempted after this.
Does PagerDuty communicate back to Hawkeye?
No. This integration uses email and is unidirectional.
What if I’m unable to configure email services in Hawkeye?
Detailed instructions can be found in the Hawkeye User Guide.