Skip to content

关于本页

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

注意

Please note that we currently only support Zabbix of version 6 and above (6.0^)

认证 ​

此提供商需要身份验证。

  • zabbix_frontend_url: Zabbix 前端 URL(必需:True,敏感:False)
  • auth_token: Zabbix 认证令牌(必需:True,敏感:True)
  • verify: 验证 SSL 证书(必需:False,敏感:False)

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

  • action.create: 此方法允许创建新操作。(强制)(文档)
  • action.get: 此方法允许检索操作。(强制)(文档)
  • event.acknowledge: 此方法允许更新事件。(强制)(文档)
  • mediatype.create: 此方法允许创建新的媒体类型。(强制)(文档)
  • mediatype.get: 此方法允许检索媒体类型。(强制)(文档)
  • mediatype.update: 此方法允许更新媒体类型。(强制)(文档)
  • problem.get: 此方法允许检索问题。(强制)(文档)
  • script.create: 此方法允许创建新脚本。(强制)(文档)
  • script.get: 此方法允许检索脚本。(强制)(文档)
  • script.update: 此方法允许更新脚本。(强制)(文档)
  • user.get: 此方法允许检索用户。(强制)(文档)
  • user.update: 此方法允许更新用户。(强制)(文档)

在工作流中 ​

此提供商不能用作工作流中的"步骤"或"操作"。如果您想使用它,请通过在 GitHub 仓库 创建问题告诉我们。

提供商方法 ​

此提供商暴露以下提供商方法。它们在 AI 助手中可用。

  • close_problem 无描述。(操作,范围:event.acknowledge)

    • id: 问题 ID。
  • change_severity 无描述。(操作,范围:event.acknowledge)

    • id: 问题 ID。
    • new_severity: 新的严重程度。可以是整数字符串(0-5)或严重程度名称:
  • "0" 或 "未分类"

  • "1" 或 "信息"

  • "2" 或 "警告"

  • "3" 或 "一般"

  • "4" 或 "高"

  • "5" 或 "灾难"

  • surrpress_problem 无描述。(操作,范围:event.acknowledge)

    • id: 问题 ID。
    • suppress_until: 抑制问题直到的日期时间。
  • unsurrpress_problem 无描述。(操作,范围:event.acknowledge)

    • id: 问题 ID。
  • acknowledge_problem 无描述。(操作,范围:event.acknowledge)

    • id: 问题 ID。
  • unacknowledge_problem 无描述。(操作,范围:event.acknowledge)

    • id: 问题 ID。
  • add_message_to_problem 无描述。(操作,范围:event.acknowledge)

    • id: 问题 ID。
    • message_text: 消息文本。
  • get_problem_messages 无描述。(视图,范围:problem.get)

    • id: 问题 ID。

连接 Provider ​

API 密钥 ​

要获取 Zabbix 认证令牌,请按照以下步骤操作,这些步骤分为三类(文档):

首先,使用特权用户登录您的 Zabbix 账户(提供的 zabbix_frontend_url)。

创建用户角色 ​

  1. 导航至 Users -> User Roles 部分。
  2. 在屏幕右上角,点击 Create user role
  3. 为角色提供一个指示性名称(例如 Keep Role)
  4. 在 User type 选择框中,选择 Super Admin
  • 这是因为我们需要的一些范围仅在 Super Admin 用户类型下可用。见此处
  1. 从所有内容中删除所有复选框,只保留 1 个随机 Access to UI elements,这是任何角色都需要的。
  2. 在 API methods 部分,选择 Allow list 并填写以下范围:
  • action.create
  • action.get
  • event.acknowledge
  • mediatype.create
  • mediatype.get
  • mediatype.update
  • problem.get
  • script.create
  • script.get
  • script.update
  • user.get
  • user.update

创建用户 ​

  1. 导航至 Users -> Users 部分。
  2. 按照说明添加新用户。为其提供一个指示性用户名(例如 KeepUser)
  3. 在 Permissions 选项卡中,选择您刚刚创建的角色。
  4. 点击 Add

创建 API 令牌 ​

  1. 导航至 Users -> API tokens 部分。
  2. 在屏幕右上角,点击 Create API token
  3. 为 API 令牌提供一个指示性名称(例如 Keep Token)
  4. 选择您刚刚创建的用户
  5. 取消选择 Set expiration date and time 复选框,然后点击 Add
  6. 复制生成的 API 令牌并在 Keep 中保留以供进一步使用。

注意事项 ​

::: note 在安装 Zabbix webhook 时,Keep 会自动添加一个新的类型为 Keep 的媒体类型到您的媒体类型中。

添加新媒体类型后,Keep 会自动将此媒体类型作为媒体添加到所有现有用户,以获取 来自 Zabbix 的所有传入告警。 :::

Webhook 集成修改 ​

自动 webhook 集成授予 Keep 对 Zabbix 实例内以下范围的访问权限:

  • mediatype.get
  • mediatype.update
  • mediatype.create
  • user.get
  • user.update

您可以在 Alerts > Media Types 下查看 webhook 设置

相关链接 ​

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