AWS IDR documentation change
Summary
Updated IDR workload onboarding questionnaire: simplified service listing format, removed compliance example, restructured alarm matrix tables, and added EventBridge integration details.
Security assessment
Changes are documentation improvements without security vulnerability fixes. Removal of compliance example doesn't indicate security issues. Restructured alarm tables improve operational clarity but don't address security weaknesses.
Diff
diff --git a/IDR/latest/userguide/idr-gs-questionnaire.md b/IDR/latest/userguide/idr-gs-questionnaire.md index 307625567..e59382fd2 100644 --- a//IDR/latest/userguide/idr-gs-questionnaire.md +++ b//IDR/latest/userguide/idr-gs-questionnaire.md @@ -13 +13 @@ Workload onboarding questionnaire - General questionsWorkload onboarding questio -If you are unable to use the AWS Incident Detection and Response Customer Command Line Interface to onboard your workload, use the following questionnaires for workload and alarm onboarding. +If you can't use the [IDR CLI](./idr-gs-idrcli.html) to onboard your workload, use the following questionnaires for workload and alarm onboarding. @@ -15 +15 @@ If you are unable to use the AWS Incident Detection and Response Customer Comman -This page provides the questionnaires you need to complete when onboarding a workload to AWS Incident Detection and Response and when configuring alarms to ingest into the service. The workload onboarding questionnaire covers general information about your workload, its architecture details, and contacts for incident response. In the alarm ingestion questionnaire, you specify the critical alarms that should trigger incident creation in Incident Detection and Response for your workload, as well as runbook information on who should be contacted and what actions should be taken. Properly completing these questionnaires is a key step in setting up monitoring and incident response processes for your AWS workloads. +This topic provides the questionnaires you need to complete when onboarding a workload to AWS Incident Detection and Response and when configuring alarms to ingest into the service. The workload onboarding questionnaire covers general information about your workload, its architecture details, and contacts for incident response. In the alarm ingestion questionnaire, you specify the critical alarms that trigger incident creation in Incident Detection and Response for your workload, as well as runbook information on who to contact and what actions to take. Properly completing these questionnaires is a key step in setting up monitoring and incident response processes for your AWS workloads. @@ -42 +41,0 @@ Primary end user and the function of this workload. | This workload is an e-comm -Applicable compliance and/or regulatory requirements for this workload and any actions required from AWS after an incident. | The workload deals with patient health records which must be kept secured and confidential. @@ -53,28 +52 @@ Tags are case sensitive. If you provide multiple tags, all resources used by thi -A list of AWS services utilized by this workload and the AWS Account and Regions that they're in. - -###### Note - -Create a new row for each service. | Route 53: Routes internet traffic to the ALB. Account:123456789101 Region: US-EAST-1, US-WEST-2 -A list of AWS services utilized by this workload and the AWS Account and Regions that they're in. - -###### Note - -Create a new row for each service. | ALB: Routes incoming traffic to a target group of ECS containers. Account: 123456789101 Region: N/A -A list of AWS services utilized by this workload and the AWS Account and Regions that they're in. - -###### Note - -Create a new row for each service. | ECS: Compute infrastructure for main business logic fleet. Responsible for handling incoming user requests and making queries to persistence layer. Account: 123456789101 Region: US-EAST-1 -A list of AWS Services utilized by this workload and the AWS Account and Regions that they're in. - -###### Note - -Create a new row for each service. | RDS: Amazon Aurora cluster stores user data accessed by ECS business logic layer. Account: 123456789101 Region: US-EAST-1 -A list of AWS Services utilized by this workload and the AWS Account and Regions that they're in. - -###### Note - -Create a new row for each service. | S3: Stores website static assets. Account: 123456789101 Region: N/A -Detail any upstream/downstream components not being onboarded that could affect this workload if experiencing an outage. | Authentication Microservice: Will prevent users from loading their health records as they will be unauthenticated. -Are there any on-premise or non-AWS components for this workload? If so, what are they and what functions are performed? | All internet based traffic in/out of AWS is routed via our on-prem proxy service. -Provide details of any manual or automated failover/disaster recovery plans at the Availability Zone and regional level. | Warm standby. Automated failover to US-WEST-2 during sustained drop in success rate. +A list of AWS service(s) utilized by this workload, the AWS account(s) and AWS Region(s) that they are in. | AWS services: Route 53, ALB, ECS, ... Accounts: 123456789101, 123456789102, ... Regions: US-EAST-1, US-WEST-2, ... @@ -113 +84,0 @@ If the primary contact is unavailable during an incident, please provide escalat -AWS communicates updates through the support case at regular intervals throughout the incident. Are there additional contacts that should receive these updates? | [email protected], [email protected] @@ -140,7 +111,8 @@ Provide the contact phone number for your site reliability engineering (SRE) tea -Alarm matrix table Metric name / ARN / Threshold | Description | Notes | Actions requested ----|---|---|--- -Workload volume / `CW Alarm ARN` / CallCount < 100000 for 5 datapoints within 5 minute , treat missing data as missing | This metric represents the number of incoming requests coming to the workload, measured at the Application Load Balancer level. This alarm is important because significant drops in incoming requests may indicate issues with upstream network connectivity, or issues with our DNS implementation that result in users not being able to access the workload. | The alarm has entered the "Alarm" state 10 times in the last week. This alarm is at risk of false positives. Threshold review is planned. Issues? No or Yes (if No, leave blank): This alarm flips frequently during a particular batch job execution. Resolvers: Site Reliability Engineers | Engage the Site Reliability Engineering team by sending an email to `[email protected]` Create an AWS Support case for our ELB, and Amazon Route 53 services. If IMMEDIATE action is needed: Check EC2 Free memory/disk space and inform the `Example` team through email to restart the instance, or run a log flush. (if immediate action is not needed, leave blank) -Workload Request Latency / `CW Alarm ARN` / p90 Latency > 100ms for 5 datapoints within 5 minutes , treat missing data as missing | This metric represents the p90 latency for HTTP requests to be fulfilled by the workload. This alarm represents latency (important measure of customer experience for the website). | The alarm has entered the "Alarm" state 0 times in the last week. Issues? No or Yes (if No, leave blank): This alarm flips frequently during a particular batch job execution. Resolvers: Site Reliability Engineers | Engage the Site Reliability Engineering team by sending an email to `[email protected]` Create an AWS Support case for our ECW, and RDS services. If IMMEDIATE action is needed: Check EC2 Free memory/disk space and inform the `Example` team through email to restart the instance, or run a log flush. (if immediate action is not needed, leave blank) -Workload Request Availability / `CW Alarm ARN` / Availability < 95% for 5 datapoints within 5 minutes , treat missing data as missing. | This metric represents the availability for HTTP requests to be fulfilled by the workload. (# of HTTP 200 / # of Requests) per period. This alarm represents the availability of the workload. | The alarm has entered the "Alarm" state 0 times in the last week. Issues? No or Yes (if No, leave blank): This alarm flips frequently during a particular batch job execution. Resolvers: Site Reliability Engineers | Engage the Site Reliability Engineering team by sending an email to `[email protected]` Create an AWS Support case for our ELB, and Amazon Route 53 services. If IMMEDIATE action is needed: Check EC2 Free memory/disk space and inform the `Example` team through email to restart the instance, or run a log flush. (if immediate action is not needed, leave blank) -**New Relic Alarm Example** -End to End Integration test / `CW Alarm ARN` / 3% failure rate for 1 minute metrics over 3 minutes duration , treat missing data as missing Workload Identifier: End to End Test Workflow, AWS Region: US-EAST-1, AWS account ID: 012345678910 | This metric tests if a request can traverse each layer of the workload. If this test fails, it represents a critical failure to process business transactions. This alarm represents the ability to process business transactions for the workload. | The alarm has entered the "Alarm" state 0 times in the last week. Issues? No or Yes (if No, leave blank): This alarm flips frequently during a particular batch job execution. Resolvers: Site Reliability Engineers | Engage the Site Reliability Engineering team by sending an email to `[email protected]` Create an AWS Support case for our Amazon Elastic Container Service, and Amazon DynamoDB services. If IMMEDIATE action is needed: Check EC2 Free memory/disk space and inform the `Example` team through email to restart the instance, or run a log flush. (if immediate action is not needed, leave blank) +Alarm matrix table for CloudWatch alarms **CloudWatch alarm ARN** | **Primary contact for this alarm.** **(If different from workload primary contact)** | **Specify the most relevant AWS service for this alarm to engage the right engineer. Enter N/A if not needed.** +---|---|--- +Example: `arn:aws:cloudwatch:us-east-1:123456789012:alarm:ALB_5xx_Target_Response` | Example: Sam Smith - Application Manager [email protected] +61 2 3456 7890 | Example: ECS + +Alarm matrix table for third-party APM alarms **EventBridge Event Bus ARN** **(This is created as part of the third-party APM integration to route alerts to AWS Incident Detection and Response.)** | Example: (There will be an event bus per Account/Region combination) `arn:aws:events:us-east-1:123456789012:event-bus/APMName-AWSIncidentDetectionResponse-EventBus` `arn:aws:events:us-west-1:123456789012:event-bus/APMName-AWSIncidentDetectionResponse-EventBus` +---|--- +**Alarm Identifier** | **What does this metric represent?** **Why is this alarm important?** | **Primary contact for this alarm.** **(If different from workload primary contact)** | **Specify the most relevant AWS service for this alarm to engage the right engineer. Enter N/A if not needed.** +Example: ALB_5xx_Target_Response Account ID: 123456789012 Region: us-east-1 | Example: This metric represents transaction responses from the targets behind the ALB. If 5XX errors exceeds threshold, it represents a critical failure to process business transactions. | Example: Sam Smith - Application Manager [email protected] +61 2 3456 7890 | Example: ECS