关于本页

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

在工作流中

此提供商可用于工作流。

作为"步骤"来查询数据，示例：

steps:
    - name: Query keep
      provider: keep
      config: "{{ provider.my_provider_name }}"
      with:
        filters: {value}  # 过滤查询 Keep（仅适用于版本 1）
        version: {value}  # Keep API 版本
        distinct: {value}  # 如果为 True，仅返回不同的警报
        time_delta: {value}  # 查询 Keep 的时间增量（天）
        timerange: {value}  # 计算时间增量的时间范围字典
        filter: {value}  # 过滤查询 Keep（仅适用于版本 2）
        limit: {value}  # 限制结果数量（仅适用于版本 2）

作为"操作"来进行更改或更新数据，示例：

actions:
    - name: Query keep
      provider: keep
      config: "{{ provider.my_provider_name }}"
      with:
        delete_all_other_workflows: {value}  # 如果为 True，删除所有其他工作流
        workflow_full_sync: {value}  # 如果为 True，同步所有工作流
        workflow_to_update_yaml: {value}  # 要更新的工作流 yaml
        alert: {value}  # 要创建的警报数据
        fingerprint_fields: {value}  # 用于警报指纹的字段
        override_source_with: {value}  # 覆盖警报来源
        read_only: {value}  # 如果为 True，不修改现有警报
        fingerprint: {value}  # 警报指纹
        if: {value}  # 评估警报创建的条件
        for: {value}  # 状态警报的持续时间

请查看以下工作流示例：

• create_alert_from_vm_metric.yml
• create_alert_in_keep.yml
• create_alerts_from_elastic.yml
• create_alerts_from_mysql.yml
• create_multi_alert_from_vm_metric.yml
• fluxcd_example.yml
• resolve_old_alerts.yml
• retrieve_cloudwatch_logs.yaml
• update_service_now_tickets_status.yml
• update_workflows_from_http.yml
• update_workflows_from_s3.yml
• webhook_example_foreach.yml

认证参数

要使用 Keep provider，您必须使用与 Keep 账户关联的 API token 进行认证。该 token 可以从 Keep 仪表板生成。

连接 Provider

1. 登录您的 Keep 账户。
2. 导航至账户仪表板的 API 部分并生成 API token。
3. 通过 Keep provider 查询告警时使用此 token 进行认证。