AWS devopsagent documentation change
Summary
Updated documentation for AWS DevOps Agent's proactive incident prevention feature, including renaming from 'prevention' to 'proactive incident prevention', changing access location to 'Ops Backlog page', restructuring recommendation categories, adding new sections for controlling evaluations, managing recommendations, and agent-ready specifications, and updating terminology from 'Accept/Reject' to 'Keep/Discard/Implemented'.
Security assessment
The changes are documentation updates about operational improvements and incident prevention workflows. There is no mention of security vulnerabilities, patches, or security incidents. The changes focus on feature renaming, UI location changes, recommendation categorization, and workflow improvements without any security-specific context or evidence of addressing security issues.
Diff
diff --git a/devopsagent/latest/userguide/working-with-devops-agent-proactive-incident-prevention.md b/devopsagent/latest/userguide/working-with-devops-agent-proactive-incident-prevention.md index adde09fef..73f7dfef3 100644 --- a//devopsagent/latest/userguide/working-with-devops-agent-proactive-incident-prevention.md +++ b//devopsagent/latest/userguide/working-with-devops-agent-proactive-incident-prevention.md @@ -5 +5 @@ -How prevention worksBenefitsAgent summaryRecommendation categorizationControlling evaluationsManaging recommendationsImplementing recommendations +How proactive incident prevention worksBenefitsAgent summaryControlling evaluationsManaging recommendationsAgent-ready specificationsImplementing recommendations @@ -9 +9 @@ How prevention worksBenefitsAgent summaryRecommendation categorizationControllin -AWS DevOps Agent analyzes patterns across your incident investigations to deliver targeted recommendations that continuously improve your operational posture and prevent future incidents. Access the Prevention feature through the Prevention page in the Operator Web App. +AWS DevOps Agent analyzes patterns across your incident investigations to deliver targeted recommendations that continuously improve your operational posture and prevent future incidents. Access proactive incident prevention through the Ops Backlog page in the Operator Web App. @@ -11 +11 @@ AWS DevOps Agent analyzes patterns across your incident investigations to delive -## How prevention works +## How proactive incident prevention works @@ -15 +15 @@ AWS DevOps Agent evaluates recent incident investigations to identify lasting im -The agent automatically runs evaluations weekly. You can also manually trigger an evaluation at any time, which is useful when a recent investigation warrants a quick turnaround on recommended improvements. +By default, the agent automatically runs evaluations weekly. You can pause the schedule if you prefer to run evaluations only on demand. Manual evaluations are always available, which is useful when a recent investigation warrants a quick turnaround on recommended improvements. @@ -17 +17 @@ The agent automatically runs evaluations weekly. You can also manually trigger a -The agent identifies improvements across four areas: +The agent identifies improvements across four categories, shown in the Recommendation Categorization chart on the Ops Backlog page: @@ -19 +19 @@ The agent identifies improvements across four areas: - * **Observability posture** – Recommendations to enhance monitoring, alerting, and logging capabilities to detect issues quicker and more accurately. + * **Observability** – Recommendations to enhance monitoring, alerting, logging, and system visibility to detect issues quicker and more accurately. @@ -21 +21,3 @@ The agent identifies improvements across four areas: - * **Testing gaps** – Recommendations to strengthen testing and validation processes in your deployment pipelines. + * **Infrastructure** – Recommendations to optimize resource configurations, capacity tuning, and architectural resilience. + + * **Governance** – Recommendations to strengthen deployment processes, pipeline improvements, testing practices, and operational controls. @@ -23 +25 @@ The agent identifies improvements across four areas: - * **Code changes** – Recommendations to better improve resilience and performance. + * **Code optimization** – Recommendations to improve application code quality, error handling, and code resilience. @@ -25 +26,0 @@ The agent identifies improvements across four areas: - * **Infrastructure architecture** – Recommendations to optimize resource configurations, implement autoscaling, and improve system resilience. @@ -28,0 +30 @@ The agent identifies improvements across four areas: +This categorization helps you understand where your operational improvements are most needed and allows you to prioritize recommendations based on your team's focus areas. @@ -45 +47 @@ The agent identifies improvements across four areas: -The Agent Summary in the Prevention page of the Web App provides a description of the outcomes from the last evaluation of recent incidents. The summary explains the number of incident investigations analyzed, which incidents are similar to past ones, and which recommendations were created or updated with new information. +The Agent Summary in the Ops Backlog page of the Web App provides a description of the outcomes from the last evaluation of recent incidents. The summary explains the number of incident investigations analyzed, which incidents are similar to past ones, and which recommendations were created or updated with new information. @@ -49 +51 @@ The summary helps you quickly understand what the agent discovered during its mo -## Recommendation categorization +## Controlling evaluations @@ -51 +53 @@ The summary helps you quickly understand what the agent discovered during its mo -The Recommendation Categorization chart shows the distribution of recommendations across four key categories: +You can control when AWS DevOps Agent evaluates incidents and generates recommendations: @@ -53 +55 @@ The Recommendation Categorization chart shows the distribution of recommendation - * **Code optimization** – Recommendations to improve application code quality, performance, and error handling. + * **Running evaluations manually** – Click the **Run Now** button in the Ops Backlog page to start an evaluation immediately. This is useful when a recent investigation warrants a quick turnaround on recommended improvements. @@ -55 +57 @@ The Recommendation Categorization chart shows the distribution of recommendation - * **Observability** – Recommendations to enhance monitoring, alerting, logging, and system visibility. + * **Stopping active evaluations** – Click the **Stop Evaluation** button in the Ops Backlog page to halt an evaluation that is currently in progress. @@ -57 +58,0 @@ The Recommendation Categorization chart shows the distribution of recommendation - * **Infrastructure** – Recommendations to optimize resource configurations, capacity tuning, and architectural resilience. @@ -59 +59,0 @@ The Recommendation Categorization chart shows the distribution of recommendation - * **Governance** – Recommendations to strengthen deployment processes, testing practices, and operational controls. @@ -61,0 +62 @@ The Recommendation Categorization chart shows the distribution of recommendation +## Managing recommendations @@ -62,0 +64 @@ The Recommendation Categorization chart shows the distribution of recommendation +AWS DevOps Agent provides recommendations in the Ops Backlog page where you can review and manage them: @@ -64 +66 @@ The Recommendation Categorization chart shows the distribution of recommendation -This categorization helps you understand where your operational improvements are most needed and allows you to prioritize recommendations based on your team's focus areas. + * **Viewing recommendation details** – Click on a recommendation to open the recommendation details page, where you can see more information about the suggested improvement including the incidents that informed the recommendation, the expected impacts, and next steps. For recommendations with code changes, you can also view the agent-ready specification that can be handed to a coding agent for implementation. @@ -66 +68 @@ This categorization helps you understand where your operational improvements are -## Controlling evaluations + * **Keep** – Click ‘Keep’ to retain a recommendation in your backlog for tracking. This allows you to monitor which improvements you plan to implement and track their progress. @@ -68 +70 @@ This categorization helps you understand where your operational improvements are -You can control when AWS DevOps Agent evaluates incidents and generates recommendations: + * **Discard** – Click ‘Discard’ to remove a recommendation from your backlog. When you discard a recommendation, you can provide a natural language explanation of why it doesn’t meet your needs. The agent learns from this feedback and uses it to inform future recommendations, ensuring they become more aligned with your operational priorities and requirements over time. @@ -70 +72 @@ You can control when AWS DevOps Agent evaluates incidents and generates recommen - * **Running evaluations manually** – Click the **Run Now** button in the Prevention page to start an evaluation immediately. This is useful when a recent investigation warrants a quick turnaround on recommended improvements. + * **Implemented** – Click ‘Implemented’ to mark a recommendation as completed. This helps you track which improvements have been applied and allows the agent to measure the effectiveness of its recommendations over time. @@ -72 +74 @@ You can control when AWS DevOps Agent evaluates incidents and generates recommen - * **Stopping active evaluations** – Click the **Stop Evaluation** button in the Prevention page to halt an evaluation that is currently in progress. + * **Automatic removal** – Recommendations that have not been marked as Keep or Implemented may be removed after approximately 6 weeks if no new incidents would have been prevented by implementing the recommendation. This ensures the Ops Backlog page focuses on the most relevant improvements for your operational challenges. @@ -73,0 +76 @@ You can control when AWS DevOps Agent evaluates incidents and generates recommen + * **Recommendation updates** – Existing recommendations are updated when newer incidents are found that would have been prevented by the recommendation. Updates may change the recommendation’s priority or refine the recommendation based on new insights. @@ -77 +79,0 @@ You can control when AWS DevOps Agent evaluates incidents and generates recommen -## Managing recommendations @@ -79 +81,3 @@ You can control when AWS DevOps Agent evaluates incidents and generates recommen -AWS DevOps Agent provides recommendations in the Prevention page where you can review and manage them: +## Agent-ready specifications + +For recommendations that involve code or configuration changes, AWS DevOps Agent can generate an agent-ready specification. This specification provides a structured document that can be handed directly to a coding agent for implementation. @@ -81 +85 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r - * **Viewing recommendation details** – Click on a recommendation to open the recommendation details page, where you can see more information about the suggested improvement including the incidents that informed the recommendation, the expected impacts, and next steps. +The specification includes: @@ -83 +87 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r - * **Accepting recommendations** – To accept a recommendation, click ‘Accept’ in the recommendation table. When you accept a recommendation, it remains in the recommendation table for tracking. This allows you to monitor which improvements you plan to implement and track their progress. + * **Problem statement** – A summary of the issue and its root cause @@ -85 +89 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r - * **Rejecting recommendations** – To reject a recommendation, click ‘Reject’ in the recommendation table. When you reject a recommendation, you can provide a natural language explanation of why it doesn't meet your needs. The agent learns from this feedback and uses it to inform future recommendations, ensuring they become more aligned with your operational priorities and requirements over time. + * **Solution summary** – A high-level description of the recommended approach @@ -87 +91 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r - * **Automatic removal** – Recommendations that are not accepted may be removed after approximately 6 weeks if no new incidents would have been prevented by implementing the recommendation. This ensures the Prevention page focuses on the most relevant improvements for your operational challenges. + * **Target repositories** – The specific repositories where changes need to be made @@ -89 +93 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r - * **Recommendation updates** – Existing recommendations are updated when newer incidents are found that would have been prevented by the recommendation. Updates may change the recommendation's priority or refine the recommendation based on new insights. + * **Code changes** – Detailed descriptions of what needs to change and why, with specific file paths and implementation considerations @@ -90,0 +95 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r + * **Test requirements** – What scenarios need to be tested @@ -91,0 +97 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r + * **Implementation plan** – A phased approach to implementing the changes @@ -93,0 +100,4 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r + + +Agent-ready specifications accelerate implementation by providing coding agents with the context they need to make production-ready changes without requiring extensive back-and-forth with engineers. + @@ -96 +106,3 @@ AWS DevOps Agent provides recommendations in the Prevention page where you can r -To maximize the value of Prevention recommendations, consider the following practices for acting on them: +To maximize the value of proactive incident prevention recommendations, consider the following practices for acting on them: + + * **Using agent-ready specifications** – For recommendations with code changes, use the generated specification to accelerate implementation by handing it to a coding agent or using it as a detailed guide for manual implementation. @@ -98 +110 @@ To maximize the value of Prevention recommendations, consider the following prac - * **Adding recommendations to your ticket backlog** – Copy accepted recommendations to your team's ticketing system or project management tool to ensure they are prioritized alongside other engineering work. + * **Adding recommendations to your ticket backlog** – Copy recommendations to your team's ticketing system or project management tool to ensure they are prioritized alongside other engineering work.