关于本页

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

认证

此提供商需要身份验证。

• VMAlertHost: VMAlert 运行的主机名或 IP 地址（必需：False，敏感：False）
• VMAlertPort: VMAlert 正在监听的端口号（必需：False，敏感：False）
• VMAlertURL: VMAlert 实例的完整 URL。Host/Port 的替代方案（必需：False，敏感：False）
• VMBackendHost: VictoriaMetrics 后端运行的主机名或 IP 地址（必需：False，敏感：False）
• VMBackendPort: VictoriaMetrics 后端正在监听的端口号（必需：False，敏感：False）
• VMBackendURL: VictoriaMetrics 后端的完整 URL。Host/Port 的替代方案（必需：False，敏感：False）
• BasicAuthUsername: 基本身份验证的用户名（必需：False，敏感：False）
• BasicAuthPassword: 基本身份验证的密码（必需：False，敏感：True）
• SkipValidation: 输入 'true' 跳过身份验证（必需：False，敏感：False）
• insecure: 跳过 TLS 验证（必需：False，敏感：False）

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

• connected: 用户可以连接到客户端（强制）

在工作流中

此提供商可用于工作流。

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

steps:
    - name: Query victoriametrics
      provider: victoriametrics
      config: "{{ provider.my_provider_name }}"
      with:
        query: {value}
        start: {value}
        end: {value}
        step: {value}
        queryType: {value}

请查看以下工作流示例：

• create_alert_from_vm_metric.yml
• create_multi_alert_from_vm_metric.yml
• query_victoriametrics.yml

通过 Webhook 连接（双向）

此提供商利用 Prometheus Alertmanager 的可配置 webhook。使用以下模板配置 AlertManager：

route:
  receiver: "keep"
  group_by: ['alertname']
  group_wait:      15s
  group_interval:  15s
  repeat_interval: 1m
  continue: true

receivers:
- name: "keep"
  webhook_configs:
  - url: 'KEEP_BACKEND_URL/alerts/event/victoriametrics'
    send_resolved: true
    http_config:
      basic_auth:
        username: api_key
        password: {api_key}

连接 Provider

1. 确保您有一个可访问的主机和端口上运行的 VMAlert 实例。
2. 在初始化 provider 时，在 Victoriametrics provider 配置中包含主机和端口信息。

查询 Victoriametrics

Victoriametrics provider 允许您通过 query 和 query_range 类型从 Victoriametrics 查询。以下是可用于查询的参数：

1. query 类型：

   • query：在 Victoriametrics 上执行的查询。示例：sum(rate(http_requests_total{job="api-server"}[5m]))。
   • start：查询数据的时间。示例：2024-01-01T00:00:00Z

2. query_range 类型：

   • query：在 Victoriametrics 上执行的查询。示例：sum(rate(http_requests_total{job="api-server"}[5m]))。
   • start：查询数据的开始时间。示例：2024-01-01T00:00:00Z
   • end：查询数据的结束时间。示例：2024-01-01T00:00:00Z
   • step：查询使用的步长。示例：15s

相关链接

• Victoriametrics
• VMAlert