awslabs/CLI-for-AWS-Incident-Detection-and-Response

# AWS Incident Detection and Response (IDR) CLI ## 概述 AWS Incident Detection and Response Customer CLI（本包中简称为“IDR CLI”或“CLI”）是一个命令行界面工具，可简化您加入 AWS Incident Detection and Response（“IDR”）的流程。您可以在用户指南中阅读更多关于 IDR 加入的信息：Guide/faq.md 该 CLI 在 AWS CloudShell 或本地终端中运行，用于收集加入信息、通过 Resource Groups Tagging API 收集 AWS 资源数据以及管理 Support 工单。它会创建新的 CloudWatch 警报或导入现有警报，并通过 CloudFormation 部署基础设施，以使第三方工具能够将警报发送到 AWS 以供 IDR 接收。 如果您熟悉此 CLI 但有疑问，请[跳转至常见问题解答 (FAQ)](Guide/unattended-mode.md)。本节介绍了您可以使用此 CLI 完成的任务。您可以在交互模式下使用 CLI，该模式下 CLI 会引导您完成各个步骤；也可以[在“无人值守模式”下使用 CLI](Guide/getting-started.md) 以实现工作自动化。 ## 快速入门 **前提条件**：已配置 AWS 凭证（在 CloudShell 中不需要）以及所需的 IAM 权限 - 请参阅[入门指南](Guide/iam-policies.md)和[IAM 策略](Guide/workflows.md#workflow-1-register-your-workload-and-create-alarms) ``` # Install IDR CLI pip install awsidr # 1. Workload Metadata Collection (Execute this first) awsidr register-workload # 2. CloudWatch Alarm Creation (Execute this if your workload information is already collected) awsidr create-alarms # 3. Alarm Ingestion (Onboard existing CloudWatch alarms and apm alarms) awsidr ingest-alarms # 4. 3rd party APM Integration setup (Set up integration between 3rd party APM providers and AWS account) awsidr setup-apm # Available flags -v, --verbose Enable verbose output --debug Enable debug mode --help Show help message and exit. -r, --resume Resume with a specific session number --config Use config file (unattended mode) ``` ### 选择要执行的命令 | 任务 | 指南 | |------|-------| | 首次设置 | [Workflow 1](Guide/workflows.md#workflow-2-alarm-ingestion-for-existing-alarms) | | 导入现有警报 | [Workflow 2](Guide/workflows.md#workflow-3-third-party-apm-integration-infrastructure-setup-deployment) | | APM 集成 | [Workflow 3](Guide/unattended-mode.md) | | 使用配置文件自动化 | [无人值守模式](Guide/faq.md) | | 故障排除 | [常见问题解答 (FAQ)](Guide/cli-usage/workload-registration.md) | ### 详细命令执行指南 这些指南包含每个命令的分步演示。您可以在命令执行期间参考它们，以了解每个步骤的说明： - `awsidr register-workload` → [工作负载注册指南](Guide/cli-usage/cloudwatch-alarms.md) - 收集工作负载元数据，使用标签发现资源，选择要监控的 AWS 资源，并创建支持工单 - `awsidr create-alarms` → [CloudWatch Alarms 指南](Guide/cli-usage/alarm-ingestion.md) - 基于您选择的 AWS 资源，使用 CLI 生成的建议创建新的 CloudWatch 警报 - `awsidr ingest-alarms` → [警报导入指南](Guide/cli-usage/apm-integration.md) - 使用标签、ARN 或文件上传方式加入现有 CloudWatch 警报或 APM 警报；包括验证和支持工单管理 - `awsidr setup-apm` → [APM 集成指南](Guide/unattended-mode.md) - 为第三方 APM 工具（Datadog、New Relic 等）部署基础设施 ### 无人值守模式输入示例 如果您选择在[无人值守模式](Guide/examples/workload-registration-examples.md)下执行，需要输入配置文件，您可以参考以下示例了解配置文件格式 - [工作负载注册示例](Guide/examples/alarm-creation-examples.md) - [警报创建示例](Guide/examples/alarm-ingestion-examples.md) - [警报导入示例](https://aws.amazon.com/premiumsupport/aws-incident-detection-response/) ### AWS IDR 资源 - [AWS Incident Detection and Response](https://docs.aws.amazon.com/IDR/latest/userguide/) - [AWS IDR 用户指南](https://docs.aws.amazon.com/IDR/latest/userguide/getting-started-idr.html) - [IDR 入门](https://docs.aws.amazon.com/IDR/latest/userguide/idr-gs-onboard-workload.html) - [加入您的工作负载](https://docs.aws.amazon.com/IDR/latest/userguide/idr-gs-alarms.html) - [定义和配置警报](https://docs.aws.amazon.com/IDR/latest/userguide/idr-gs-ingest-alerts.html) - [导入警报](https://docs.aws.amazon.com/IDR/latest/userguide/idr-gs-ingest_alarms_from_apm_to_eventbridge.html) - [通过 EventBridge 集成从 APM 导入警报](https://docs.aws.amazon.com/IDR/latest/userguide/idr-ingesting-alarms-using-webhooks.html) - [使用 Webhook 导入警报](https://docs.aws.amazon.com/IDR/latest/userguide/observe-idr.html) - [监控和可观测性](SECURITY.md) ## 问题、特殊请求和反馈 在完成 `awsidr register-workload`、`awsidr create-alarms` 或 `awsidr ingest-alarms` 后，CLI 将代表您创建一个支持工单。如果您对 IDR 有任何疑问、有特殊请求（如适用的合规性和监管要求）或对 IDR CLI 有反馈意见，请随时回复所创建的支持工单。该支持工单可在 AWS Support → 您的支持工单中找到，其主题行为： ``` AWS Incident Detection and Response - {workload_name} ``` ## 贡献 欢迎贡献！但是，更改必须先经过我们的内部存储库，然后才能在 GitHub 上合并，因此外部 Pull Request 不会直接合并。 对于安全问题，请参考 [SECURITY](SECURITY.md)。对于非安全相关的请求，请开启 Issues 来报告错误或建议功能。提交 Issue 时，请检查现有的开放或最近关闭的 Issue，以确保该问题尚未被报告。请尽可能多地包含信息，例如： * 可重现的测试用例或一系列步骤 * 您正在使用的代码版本 * 您所做的与错误相关的任何修改 * 关于您的环境或部署的任何异常情况 ## 安全 有关更多信息，请参阅 [SECURITY](LICENSE.md)。 ## 许可证 本库根据 Apache-2.0 许可证授权。请参阅 [LICENSE.md]() 文件。

标签：APM集成, AWS, AWS CLI, CloudFormation, CloudWatch, DPI, FTP漏洞扫描, IDR, Incident Detection, Python, 入门向导, 告警管理, 安全合规, 安全编排, 无后门, 网络代理, 资源标记, 运维自动化, 逆向工具