AWS Health Dashboard Integration Guide | PagerDuty
Configure the AWS Health Dashboard integration
AWS Health Dashboard + PagerDuty Benefits
- The AWS Health Dashboard integration allows you to automate response workflows for infrastructure problems that may be impacting your AWS services.
- Send issues and scheduled changes from AWS to PagerDuty.
Requirements
To Configure the Integration:
- In PagerDuty: Managers, Admins, Global Admins and Account Owners can configure the integration.
- In AWS: Users who set up and manage AWS Config must have full-access permissions. Please read Amazon’s documentation Granting Permissions for AWS Config Administration for more information about managing permissions in AWS.
How it Works
- When AWS is experiencing problems, Amazon EventBridge sends AWS Health Dashboard events to PagerDuty.
- These events then generate PagerDuty incidents and notify responders.
Version
This guide details configuration of the AWS Health Dashboard V1 integration.
Integration Walkthrough
In PagerDuty
There are three ways to integrate AWS Health Dashboard with PagerDuty:
- Integrate With Event Orchestration: Integrating with Event Orchestration may be beneficial if you want to build nested rules based on the payload coming from AWS.
- Integrate With Event Rules: Integrating with global or service-level event rules may be beneficial if you want to build different rules based on the payload coming from AWS.
- Integrate With a PagerDuty Service: Integrating with a PagerDuty service directly can be beneficial if you don’t need to route alerts from AWS to different responders based on the event payload. You can still use service-level Event Orchestration to perform actions such as suppressing.
Integrate With Event Orchestration
Configure a Global Orchestration Integration
- Configure a Global Orchestration in your PagerDuty account.
- Navigate to AIOps Event Orchestration click the name of your Global Orchestration.
- Click the Global Orchestration Key dropdown and then copy the Integration Key.
- Once you have your Integration Key, the Integration URL will be:
https://events.pagerduty.com/x-ere/[YOUR_INTEGRATION_KEY_HERE]
You can now proceed to the In the AWS Management Console section below.
Configure a Service Orchestration Integration
- Configure a Service Orchestration in your PagerDuty account.
- Create a Generic Events API integration on the same service.
- Once complete, copy the Integration Key and paste it into the following URL:
https://events.pagerduty.com/x-ere/[YOUR_INTEGRATION_KEY_HERE]
You can now proceed to the In the AWS Management Console section below.
Integrate With Rulesets
Event Rules End-of-Life
Rulesets and Event Rules will end-of-life in 2024. We recommend using Event Orchestration instead, which offers new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.
Configure a Global Ruleset Integration
- In the web app, navigate to AIOps Event Rules and select your Default Global Ruleset.
- On the Event Rules screen, click the Incoming Event Source dropdown and copy your Integration Key.
- Once you have your Integration Key, the Integration URL will be:
https://events.pagerduty.com/x-ere/[YOUR_INTEGRATION_KEY_HERE]
You can now proceed to the In the AWS Management Console section below.
Configure a Service Event Rules Integration
To use service-level event rules:
- Configure service event rules on your preferred service.
- Create a Generic Events API integration on the same service.
- Once complete, copy the Integration Key and paste it into the following URL:
https://events.pagerduty.com/integration/[YOUR_INTEGRATION_KEY_HERE]/enqueue
You can now proceed to the In the AWS Management Console section below.
Integrate With a PagerDuty Service
Add to a New Service
- To add the integration to a new service, navigate to Services Service Directory and click New Service.
- Follow the prompts and configure the service to your preferences. On the Integrations screen, select AWS Health Dashboard from the search bar dropdown.
- Once you are done entering your service settings, click Create Service.
- You will now be in the service’s Integrations tab. Find your integration in the list and click the to view and copy your Integration URL. Keep it in a safe place for later use.
- You can now proceed to the In the AWS Management Console section below.
Add to an Existing Service
- To add an integration to an existing service, go to Services Service Directory and select the service where you would like to configure the integration. Select the Integrations tab and click Add another integration.
- Select AWS Health Dashboard from the search bar dropdown.
- Click Add. Find your integration in the list and click the to the right to view and copy your Integration URL. Keep it in a safe place for later use.
- You can now proceed to the In the AWS Management Console section below.
In the AWS Management Console
- In the Services search bar, search and select Simple Notification Service. In the SNS dashboard left menu, select Topics and click Create Topic on the right. This topic will be used to route alerts to PagerDuty from AWS.
- Select the Standard Topic Type.
- Next, perform the following:
- Name: Enter a name for your topic. You may want to name your topic after your PagerDuty service’s name.
- Display name (optional): Enter an optional display name.
- Click Create topic.
- Now that your topic has been created, select Subscriptions in the left menu and click Create Subscription.
- Perform the following:
- Topic ARN: Select the Topic ARN of the topic you just created.
- Protocol: Select HTTPS.
- Endpoint: Paste your Integration URL (generated in steps above).
- Ensure that the Enable raw message delivery checkbox is unchecked.
- Click Create Subscription.
- Your subscription should be automatically confirmed. Refresh the page to make sure the Status is
Confirmed
and notPendingConfirmation
. - Next you will create an EventBridge alarm. Search and select Amazon EventBridge in the Services search bar. Select Rules in the left menu and then click Create rule on the right
- On the next screen, perform the following:
- Name: Enter a name that can be easily identified.
- Description (optional): Enter a description of the rule, pattern and target(s).
- Event Bus: Select default.
- Enable the rule on the selected event bus: Toggle to the on position.
- Rule with an event pattern: This will automatically be preselected.
- Click Next to continue.
- On the next page, perform the following:
- Event source: Select AWS events or EventBridge partner events.
- Sample event (optional): If you would like to view sample events, you may do so in this section.
- Event source: Select AWS services.
- AWS service: Select Health.
- Event type: You may select All Events, AWS API Call via CloudTrail or Specific Health Events based on your preference.
- Click Next to continue.
- On the next page, perform the following:
- Target types: Select AWS service.
- Select a target: Search and select SNS topic.
- Topic: Search and select the topic created in previous steps.
- Configure other additional settings to your preference.
- Click Next to continue.
- On the next page, optionally add tags to your preference. Click Next to continue.
- On the final page, review your settings and click Create Rule. If you would like to create more rules, repeat steps 7-12.
- Now that you have configured EventBridge to send AWS Health Dashboard notifications to PagerDuty, your responders will immediately be notified when AWS is experiencing problems.
Updated 2 months ago