Skip to content

关于本页

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

概述 ​

ilert provider 促进了与 ilert API 的交互,允许管理事件。这包括创建、更新和解决事件的能力,以及发送自定义事件通知。此 provider 将 Keep 的系统与 ilert 强大的告警和事件管理平台集成。

认证 ​

此提供商需要身份验证。

  • ilert_token: ILert API 令牌(必需:True,敏感:True)
  • ilert_host: ILert API 主机(必需:False,敏感:False)

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

  • read_permission: 读取权限(强制)
  • write_permission: 写入权限

在工作流中 ​

此提供商可用于工作流。

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

yaml
steps:
    - name: Query ilert
      provider: ilert
      config: "{{ provider.my_provider_name }}"
      with:
        incident_id: {value}

作为"操作"来进行更改或更新数据,示例:

yaml
actions:
    - name: Query ilert
      provider: ilert
      config: "{{ provider.my_provider_name }}"
      with:
        _type: {value}  # 通知的类型('incident' 或 'event')- 决定使用哪个端点
        summary: {value}  # 事件的简要摘要(新建事件必需)
        status: {value}  # 事件的当前状态(INVESTIGATING, RESOLVED, MONITORING, IDENTIFIED)
        message: {value}  # 描述事件的详细消息(默认:空字符串)
        affectedServices: {value}  # 受影响服务及其状态的 JSON 字符串(默认:"[]")
        id: {value}  # 要更新的事件 ID(使用"0"创建新事件)
        event_type: {value}  # 要发布的事件类型(ALERT, ACCEPT, RESOLVE)
        details: {value}  # 事件的详细信息
        alert_key: {value}  # 事件去重的唯一密钥
        priority: {value}  # 事件的优先级(HIGH, LOW)
        images: {value}  # 要包含在事件中的图片 URL 列表
        links: {value}  # 要包含在事件中的相关链接列表
        custom_details: {value}  # 用于附加上下文的自定义键值对

请查看以下工作流示例:

连接 Provider ​

要将 Keep 与 ilert 集成,请按照以下步骤操作:

  1. 登录您的 ilert 账户。
  2. 在您的账户设置下导航到 "Alert Sources"。
  3. 为 Keep 创建一个新的告警源。
  4. 记下此告警源提供的 ALERT-SOURCE-API-KEY。

用于 Keep 集成的请求端点是: (https://api.ilert.com/api/v1/events/keep/{ALERT-SOURCE-API-KEY})

相关链接 ​

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