Skip to content

关于本页

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

认证 ​

此提供商需要身份验证。

  • api_token: Axiom API 令牌(必需:True,敏感:True)
  • organization_id: Axiom 组织 ID(必需:False,敏感:False)

在工作流中 ​

此提供商可用于工作流。

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

yaml
steps:
    - name: Query axiom
      provider: axiom
      config: "{{ provider.my_provider_name }}"
      with:
        dataset: {value}
        datasets_api_url: {value}
        organization_id: {value}
        startTime: {value}
        endTime: {value}
        query: {value}  # 要执行的命令

如果您需要此提供商的工作流示例,请提交 GitHub 问题。

连接 Provider ​

要连接到 Axiom,您需要从您的 Axiom 账户创建一个 API 令牌。请按照以下步骤操作:

  1. 登录您的 Axiom 账户。
  2. 进入设置菜单下的 API Access 页面。
  3. 点击 Create Token 按钮并为令牌输入一个名称。
  4. 复制令牌值并妥善保管。
  5. 在 Axiom Provider 配置的 authentication 部分添加令牌值。

要访问数据集,您需要提供组织 ID。您可以在 Axiom Web 应用的 URL 中找到您的组织 ID。例如,如果您的 Axiom URL 是 https://app.axiom.co/organizations/1234,那么您的组织 ID 是 1234。

注意事项 ​

  • 此 Provider 支持 Axiom API 提供的有限功能集。
  • startTime 和 endTime 参数使用 ISO-8601 格式。
  • query 函数以 JSON 格式从 Axiom API 返回响应。

Webhook 集成 ​

  1. 在 Axiom 中,进入 Axiom 仪表板的 Monitors 选项卡。
  1. 点击左侧边栏中的 Notifiers 并创建一个新的通知程序。
  1. 为其命名,选择 Custom Webhook 作为通知程序类型。将 webhook URL 输入为 https://api.keephq.dev/alerts/event/axiom。
  1. 按照以下步骤在 Keep 中创建一个新的 API 密钥。

  2. 进入 Keep 仪表板,点击左下角的配置文件图标,然后点击 设置。

  1. 选择 用户和访问 选项卡,然后选择 API 密钥 选项卡,创建一个新的 API 密钥。
  1. 输入名称,选择角色为 webhook,然后点击 创建 API 密钥。
  1. 复制 API 密钥。
  1. 添加一个新的 header,键为 X-API-KEY,在 Keep 中创建一个新的 API 密钥并将其作为值粘贴,然后保存 webhook。
  1. 进入 Monitors 选项卡,点击左侧边栏中的 Monitors,创建一个新的监视器。
  1. 创建一个新的监视器,根据您的需求选择上一步创建的通知程序。请参考 Axiom Monitors 创建一个新的监视器。
  1. 保存监视器。现在您将在 Keep 中收到告警。

相关链接 ​

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