Skip to content

关于本页

本页介绍更夫所基于的开源内核 Keep 的通用能力。更夫在其上提供国内化增强:钉钉/企业微信/飞书通知、国产大模型接入、LDAP 认证与值班管理。部署与上手请看快速上手。

概述 ​

CloudWatch Provider 提供与 AWS CloudWatch 的直接集成,使 Keep 用户能够在 Keep 平台内接收 CloudWatch 告警。此集成集中了监控和告警功能,允许对基础设施或应用程序运行状况的变化做出及时响应。

主要功能: ​

  • Webhook 集成:促进自动订阅与 CloudWatch 告警关联的 AWS SNS 主题,确保 Keep 收到所有相关告警的通知。
  • 支持自定义 SNS 主题:允许使用现有的 SNS 主题并指定自定义 SNS 主题进行告警通知。
  • 广泛的监控范围:利用 CloudWatch 全面的告警系统监控应用程序和基础设施运行状况。
  • 适应性身份验证:适应永久和临时 AWS 凭据以满足各种安全和运营需求。

连接 Provider ​

要将 CloudWatch 与 Keep 集成,您需要:

  • 一个具有访问 CloudWatch 和 SNS 服务权限的 AWS 账户。
  • 配置了 API 访问的 Keep 账户。
  • CloudWatch provider 的适当 AWS IAM 权限。

设置集成 ​

TIP

为确保顺利设置过程,请确保您的 AWS IAM 角色已正确配置了 CloudWatch 和 SNS 访问的必要权限。

认证 ​

此提供商需要身份验证。

  • region: AWS 区域(必需:True,敏感:False)
  • access_key: AWS 访问密钥(如果在 EC2 上使用 IAM 角色则留空)(必需:False,敏感:True)
  • access_key_secret: AWS 访问密钥密钥(如果在 EC2 上使用 IAM 角色则留空)(必需:False,敏感:True)
  • session_token: AWS 会话令牌(必需:False,敏感:True)
  • cloudwatch_sns_topic: AWS Cloudwatch SNS 主题 [ARN 或名称](必需:False,敏感:False)
  • protocol: 用于 webhook 的协议(必需:True,敏感:False)

某些范围可能需要才能通过提供商执行特定操作或查询。以下是相关范围及其用例的摘要:

  • cloudwatch:DescribeAlarms: 需要检索警报信息。(强制)(文档)
  • cloudwatch:PutMetricAlarm: 需要更新警报信息。这主要用于将 Keep 添加为警报的 SNS 操作。(文档)
  • sns:ListSubscriptionsByTopic: 需要列出主题的所有订阅,这样 Keep 才能将自己添加为订阅。(文档)
  • logs:GetQueryResults: CloudWatchLogsReadOnlyAccess 角色的一部分。需要检索 CloudWatch Logs Insights 查询的结果。(文档)
  • logs:DescribeQueries: CloudWatchLogsReadOnlyAccess 角色的一部分。需要描述 CloudWatch Logs Insights 查询的结果。(文档)
  • logs:StartQuery: CloudWatchLogsReadOnlyAccess 角色的一部分。需要启动 CloudWatch Logs Insights 查询。(文档)
  • iam:SimulatePrincipalPolicy: 允许 Keep 测试当前用户/角色的范围而不修改任何资源。(文档)

在工作流中 ​

此提供商可用于工作流。

作为"步骤"来查询数据,示例:

yaml
steps:
    - name: Query cloudwatch
      provider: cloudwatch
      config: "{{ provider.my_provider_name }}"
      with:
        log_group: {value}
        log_groups: {value}
        remove_ptr_from_results: {value}
        query: {value}
        hours: {value}

请查看以下工作流示例:

步骤: ​

  1. 配置 AWS IAM 角色:确保 CloudWatch provider 使用的 IAM 角色具有 cloudwatch:DescribeAlarms、cloudwatch:PutMetricAlarm、sns:ListSubscriptionsByTopic 等相关操作的权限。
  2. 指定身份验证详细信息:在 Keep 平台中,在 CloudWatch provider 配置中输入 AWS Access Key、Secret 和 Region 详细信息。
  3. 设置 SNS 主题(可选):如果使用自定义 SNS 主题,请在 provider 配置中指定其 ARN 或名称。Keep 将使用此主题来监听告警通知。
  4. 激活 Provider:在 Keep 中完成设置以开始接收 CloudWatch 告警。

故障排除 ​

  • 确保提供的 AWS 凭据具有正确且未过期的权限。
  • 验证 SNS 主题已正确配置以向 Keep 发送通知。
  • 检查 CloudWatch 告警以确保它们处于活跃状态并正确配置为在所需条件下触发。

Webhook 集成修改 ​

CloudWatch 的 webhook 集成将 Keep 添加为与 CloudWatch 告警关联的 SNS 主题的订阅者。此集成允许 Keep 接收 AWS 环境中触发的所有告警的通知。 该集成自动获取对 CloudWatch 中以下范围的访问权限:

  • cloudwatch:DescribeAlarms

相关链接 ​

基于 MIT 协议开源的 Keep · 由更夫社区维护