guidance for self healing code on aws

AWS 上的自我修复代码指南

目录

1. 概述
   • 成本
2. 先决条件
   • 操作系统
3. 部署步骤
4. 部署验证
5. 运行指南
6. 下一步
7. 清理
8. 通知

概述

任何创建软件的客户都不可避免地存在错误，但同时，通常必须与产品和功能开发压力竞争，这常常迫使他们降低解决错误的优先级。这些错误可能会分散开发人员的注意力，降低用户体验并导致有关用户体验的误导性指标。即使客户优先考虑修复错误，这通常也需要以经验/熟练的工程师的形式进行业务投资，以投入大量时间和精力来理解和修复错误。

该存储库包含一个端到端系统，该系统结合了 Amazon CloudWatch、AWS Lambda 和 Amazon Bedrock，创建了一个端到端系统，可自动检测和修复错误，以增强应用程序可靠性和整体客户体验。日志驱动的错误修复程序通过 AWS Lambda 订阅挂钩到应用程序的 Amazon CloudWatch Logs 日志组。发送包含应用程序错误的任何日志进行处理；其中 Lambda 函数创建提示，包括堆栈跟踪和相关代码文件，然后将其发送到 Amazon Bedrock (Claude v1) 以生成代码修复。然后，修改后的代码将被推送到源代码管理 (git) 中，并创建拉取请求以供审查和部署。

1. AWS Lambda“错误日志处理器”函数通过 Amazon CloudWatch Logs 订阅和过滤器接收应用程序错误日志。所有 AWS Lambda 函数都承担一个 AWS IAM 角色，其范围具有访问所需资源的最低权限。
2. 应用程序错误日志中的堆栈跟踪经过 md5 哈希处理以确保唯一性，并存储在 Amazon DynamoDB 表中以跟踪其处理状态。表中的每一项代表一个唯一的错误消息。
3. AWS Lambda 函数“事件处理器”从 Amazon DynamoDB Stream 获取事件并将其发送到 Amazon SQS 进行批处理。
4. Amazon SQS 将消息排入队列，以便为 Amazon Lambda“代码优化器”功能启用批处理和并发控制。
5. AWS Lambda“代码优化器”功能会构建一个提示，其中包括源代码和相关错误消息。用于访问 Git 存储库的 SSH 密钥是从 AWS Systems Manager Parameter Store 中检索的。它通过提示调用 Amazon Bedrock 大型语言模型 (LLM)，其中包括修改后的源代码作为响应。
6. AWS Lambda“代码优化器”功能将修改后的源代码提交到新的 Git 分支中。 Git 分支及其相应的拉取请求通过 GitHub API 推送到源代码控制系统。
7. Git 用户查看拉取请求以进行测试和集成。

AWS服务

• 亚马逊云观察
• AWS Lambda
• 亚马逊基岩
• 亚马逊简单队列服务 (SQS)
• 亚马逊动态数据库
• AWS 系统经理

成本

下表提供了在美国东部（弗吉尼亚北部）区域使用默认参数部署本指南一个月的成本明细示例。

AWS服务	方面	每月费用 [美元]
亚马逊动态数据库	每条消息的平均项目大小为 0.5kb、0.5 RCU 和 1 WCU	$17.08
亚马逊云观察	每条消息写入和存储 33kb 日志	8.77 美元
AWS Lambda	每条唯一错误消息的执行时间为 45 秒	2.43 美元
亚马逊SQS	每条消息 3 个请求，1k 消息大小	0.01 美元
亚马逊基岩	1,000 个输入令牌，1,000 个输出令牌	$ 32.00
全部的		60.29 美元

成本假设

• 一个月内处理 1,000,000 条错误消息（1,000 个独特错误）。
• 免费套餐不包含在成本中。
• 每条处理的消息需要 1,000 个 Claude v2 输入和输出令牌。
• Amazon DynamoDB 表使用标准表类，按需容量。
• AWS Lambda 函数配置有 128mb 内存和 x86 架构。

先决条件

• Python 3.9+
• AWS CLI

假设

• 您的现有应用程序使用 Amazon Cloudwatch 日志。此解决方案当前连接到 CloudWatch 日志组以监控应用程序日志中的错误。
• 您使用基于 git 的源代码管理平台来托管您的代码
• 您的应用程序代码是用 Python 3 编写的。该解决方案当前仅使用 Python 3 代码库进行测试。

操作系统

该解决方案支持 Mac 或 Linux 中的构建环境。

AWS 账户要求

此部署要求您有权访问以下 AWS 服务：

• 亚马逊云观察
• AWS Lambda
• 亚马逊基岩
• 亚马逊简单队列服务 (SQS)
• 亚马逊动态数据库
• AWS Systems Manager - 参数存储

部署步骤

这些部署说明经过优化，最适合在 Mac 或 Amazon Linux 2023 上运行。在其他操作系统中部署可能需要额外的步骤。

1. 收集有关现有应用程序的以下信息，因为这些是配置解决方案所需的输入

   • 应用程序代码的 Git URL（例如：[email protected]:foo/bar.git）
   • git 存储库的 API URL（例如：https://api.github.com/repos/foo/bar）
   • 我们存储库的访问令牌或 API 密钥。对于 Github，请参阅此链接以了解创建一个的步骤
   • 对您的代码存储库具有写入权限的 SSH 私钥。
   • 您的应用程序的 AWS Cloudwatch 日志组的名称，例如：/aws/lambda/your-lambda

2. 使用命令git clone https://github.com/aws-solutions-library-samples/guidance-for-self-healing-code-on-aws.git克隆存储库

3. cd 到 repo 文件夹cd guidance-for-self-healing-code-on-aws

4. 使用命令pip install -r requirement.txt安装需求中的软件包

5. 导出所需的环境变量：

 # CloudFormation stack name.
export STACK_NAME=self-healing-code

# S3 bucket to store zipped Lambda function code for deployments.
# Note: the S3 bucket must be in the same region as the CloudFormation stack deployment region.
export DEPLOYMENT_S3_BUCKET=<NAME OF YOUR S3 BUCKET>

# All variables and secrets for this project will be stored under this prefix.
# You can define a different value if it's already in use.
export PARAMETER_STORE_PREFIX=/${STACK_NAME}/

6. 安装Python依赖项：

 pip3 install -r requirements.txt

7. 运行配置脚本并提供目标应用程序的 Amazon CloudWatch 日志组和源代码控制详细信息。这将安全地将变量和秘密存储在 SSM 参数存储中

 # Follow the resulting series of prompts to store configuration details in SSM Parameter Store. This steps will use information gathered during Step 1

python3 bin/configure.py

如果需要进行任何更改，请重新运行上述脚本。或者，您可以直接修改存储在 ${PARAMETER_STORE_PREFIX} 前缀下的 SSM 参数存储值。

8. 使用 CloudFormation 部署 AWS 资源：

 # Create a deployment package (Lambda function source code)
cloudformation/package.sh

# Deploy the CloudFormation template
cloudformation/deploy.sh

部署验证

打开 CloudFormation 控制台并使用部署步骤第 4 步中指定的堆栈名称验证模板的状态。

运行指南

在步骤 6 中配置的应用程序的 Amazon CloudWatch 日志组中收到 Python 堆栈跟踪后，将在源代码控制系统中创建拉取请求。请注意，处理可能需要几分钟才能完成。如果您想快速验证解决方案，可以将错误注入现有应用程序，这可能会导致应用程序日志中出现 python 堆栈跟踪

Github 中的输出拉取请求示例：

下一步

本指南是一个面向 Python 3.9+ 代码库的示例项目。还有进一步扩展和增强该系统的机会。一些建议的后续步骤：

• 调整src/handlers/providers中特定于提供商的提示，以优化 LLM 的响应
• 添加/修改格式提供程序以符合您的特定代码格式要求 ( src/handlers/source_code.py )
• 添加源代码控制系统提供程序以与您自己的系统集成（ src/providers/source_code.py ）

清理

1. 删除 CloudFormation 堆栈。

 aws cloudformation delete-stack --stack-name ${STACK_NAME}

2. 删除 SSM 参数存储参数。

 aws ssm delete-parameters-by-path --path ${PARAMETER_STORE_PREFIX}

通知

客户有责任对本指南中的信息进行独立评估。本指南：(a) 仅供参考，(b) 代表 AWS 当前的产品和实践，如有更改，恕不另行通知，并且 (c) 不构成 AWS 及其附属公司、供应商或许可人。 AWS 产品或服务按“原样”提供，不提供任何类型的保证、陈述或条件（无论是明示的还是暗示的）。 AWS 对客户的责任和义务由 AWS 协议控制，本指南不是 AWS 与其客户之间任何协议的一部分，也不会修改任何协议。