Skip to content

关于本页

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

运行告警。

用法 ​

Usage: keep run [OPTIONS]

选项 ​

  • alerts_directory:

    • 类型:STRING
    • 默认值:none
    • 用法:--alerts-directory --alerts-file -af

    告警 yaml/告警目录的路径

  • alert_url:

    • 类型:STRING
    • 默认值:none
    • 用法:--alert-url -au

    可用于下载告警 yaml 的 URL 注意:此参数与 alerts_directory 互斥

  • interval:

    • 类型:INT
    • 默认值:0
    • 用法:--interval -i

    设置 interval 后,Keep 将每隔 INTERVAL 秒运行一次告警

  • providers_file:

    • 类型:STRING
    • 默认值:providers.yaml
    • 用法:--providers-file -p

    提供者 yaml 的路径

  • tenant_id:

    • 类型:STRING
    • 默认值:singletenant
    • 用法:--tenant-id -t

    租户 ID

  • api_key:

    • 类型:STRING
    • 默认值:none
    • 用法:--api-key

    Keep API 的 API 密钥

  • api_url:

    • 类型:STRING
    • 默认值:https://s.keephq.dev
    • 用法:--api-url

    Keep API 的 URL

  • help:

    • 类型:BOOL
    • 默认值:false
    • 用法:--help

    显示此消息并退出.

CLI 帮助 ​

Usage: keep run [OPTIONS]

  Run the alert.

Options:
  -af, --alerts-directory, --alerts-file PATH
                                  The path to the alert yaml/alerts directory
  -au, --alert-url TEXT           A url that can be used to download an alert
                                  yaml NOTE: This argument is mutually
                                  exclusive with alerts_directory

  -i, --interval INTEGER          When interval is set, Keep will run the
                                  alert every INTERVAL seconds

  -p, --providers-file PATH       The path to the providers yaml
  -t, --tenant-id TEXT            The tenant id
  --api-key TEXT                  The API key for keep's API
  --api-url TEXT                  The URL for keep's API
  --help                          Show this message and exit.

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