docs: update alert rule documentation (#139)

This commit is contained in:
silenceqi 2025-02-14 17:20:19 +08:00 committed by GitHub
parent 34b70a925a
commit fd2746a210
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 14 additions and 4 deletions

View File

@ -31,16 +31,21 @@ Click the `New` button in the alerting rule list to enter the new alerting rule
### Configure alerting metrics and trigger conditions ### Configure alerting metrics and trigger conditions
{{% load-img "/img/screenshot/20220715-alerting-rule-new-metric.jpg" "alerting rule new" %}} {{% load-img "/img/screenshot/2025/alerting/rule_condition.png" "alerting rule new" %}}
- Input the rule name - Input the rule name
- Add the grouped fields and group size as needed, you can add more than one for terms aggregation - Add the grouped fields and group size as needed, you can add more than one for terms aggregation
- Select the metrics aggregation field and statistics type, you can configure more than one, when configuring more than one, you must configure a formula to calculate the final metrics - Select the metrics aggregation field and statistics type, you can configure more than one, when configuring more than one, you must configure a formula to calculate the final metrics
- Configure alerting trigger conditions - Configure alerting trigger conditions
- Select **Metrics value**
- Select **Bucket diff**
- Select based on **Doc diff** or **Content diff**
>**Doc diff**: The difference in the number of matching documents between two adjacent time buckets
>**Content diff**: Whether theres a change in a group between two adjacent time buckets. A difference value of 1 indicates an increase, -1 indicates a decrease, and 0 indicates no change
- Select execution check cycle - Select execution check cycle
- Input the title of the alerting event (template, referenced by the title in the template variable, click here to learn about [template syntax](./variables) ) - Input the title of the alerting event (template, referenced by the title in the template variable, click here to learn about [template syntax](./variables) )
- Input alerting event message (template, referenced by message in template variable, click here for [template syntax](./variables) ) - Input alerting event message (template, referenced by message in template variable, click here for [template syntax](./variables) )
>**Bucket Diff** is a feature introduced in INFINI Console version 1.28.2. It can be used to detect differences in data across different time periods, such as checking if theres an abnormal change in data volume during a specific time window.
### Configure message notification ### Configure message notification
{{% load-img "/img/screenshot/20220715-alerting-rule-new-notification.jpg" "alerting rule new" %}} {{% load-img "/img/screenshot/20220715-alerting-rule-new-notification.jpg" "alerting rule new" %}}

View File

@ -31,16 +31,21 @@ asciinema: true
### 配置告警指标以及触发条件 ### 配置告警指标以及触发条件
{{% load-img "/img/screenshot/20220715-alerting-rule-new-metric.jpg" "alerting rule new" %}} {{% load-img "/img/screenshot/2025/alerting/rule_condition.png" "alerting rule new" %}}
- 输入规则名称 - 输入规则名称
- 按需添加分组的字段以及分组大小,可以添加多个,用于 terms 聚合 - 按需添加分组的字段以及分组大小,可以添加多个,用于 terms 聚合
- 选择指标聚合字段以及统计类型,可以配置多个,当配置多个时必须配置公式用于计算最终的指标 - 选择指标聚合字段以及统计类型,可以配置多个,当配置多个时必须配置公式用于计算最终的指标
- 配置告警触发条件 - 配置告警触发条件
- 选择指标数值
- 选择分桶对比
- 选择基于文档差异数或者内容差异数
> 文档差异数:相邻两个时间桶内命中文档数量的差值
> 内容差异数:相邻两个时间桶内某个分组是否有变化,差异值为 1 表示增加,-1 表示减少0 表示无变化
- 选择执行检查周期 - 选择执行检查周期
- 输入告警事件标题(模版,被模版变量中的 title 引用,点击这里了解 [模版语法](./variables) - 输入告警事件标题(模版,被模版变量中的 title 引用,点击这里了解 [模版语法](./variables)
- 输入告警事件消息(模版,被模版变量中的 message 引用,点击这里了解 [模版语法](./variables) - 输入告警事件消息(模版,被模版变量中的 message 引用,点击这里了解 [模版语法](./variables)
>分桶对比是 INFINI Console 1.28.2 版本新增的功能,可以用于检测不同时间段数据的差异,比如检测某个时间段内的数据量是否有异常变化
### 配置消息通知 ### 配置消息通知
{{% load-img "/img/screenshot/20220715-alerting-rule-new-notification.jpg" "alerting rule new" %}} {{% load-img "/img/screenshot/20220715-alerting-rule-new-notification.jpg" "alerting rule new" %}}

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB