[home,webapp]操作页面新增帮助链接,完善自定义和阈值帮助文档
This commit is contained in:
36
home/docs/help/alert_threshold.md
Normal file
36
home/docs/help/alert_threshold.md
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: alert_threshold
|
||||
title: 阈值告警配置
|
||||
sidebar_label: 阈值告警配置
|
||||
---
|
||||
|
||||
> 对监控指标配置告警阈值(警告告警,严重告警,紧急告警),系统根据阈值配置和采集指标数据计算触发告警。
|
||||
|
||||
### 操作步骤
|
||||
|
||||
1. **【告警配置】->【新增阈值】-> 【配置后确定】**
|
||||
|
||||

|
||||
|
||||
如上图:
|
||||
|
||||
**指标对象**:选择我们需要配置阈值的监控指标对象 例如:网站监控类型下的 -> summary指标集合下的 -> responseTime响应时间指标
|
||||
**阈值触发表达式**:根据此表达式来计算判断是否触发阈值,表达式环境变量和操作符见页面提示,例如:设置响应时间大于50触发告警,表达式为 `responseTime > 50`。阈值表达式详细帮助见 [阈值表达式帮助](alert_threshold_expr)
|
||||
**告警级别**:触发阈值的告警级别,从低到高依次为:警告-warning,严重-critical,紧急-emergency
|
||||
**触发次数**:设置触发阈值多少次之后才会真正的触发告警
|
||||
**通知模版**:告警触发后发送的通知信息模版,模版环境变量见页面提示,例如:`${app}.${metrics}.${metric}指标的值为${responseTime},大于50触发告警`
|
||||
**全局默认**: 设置此阈值是否对全局的此类指标都应用有效,默认否。新增阈值后还需将阈值与监控对象关联,这样阈值才会对此监控生效。
|
||||
**启用告警**:此告警阈值配置开启生效或关闭
|
||||
|
||||
2. ** 阈值关联监控⚠️ 【告警配置】-> 【将刚设置的阈值】-> 【配置关联监控】-> 【配置后确定】**
|
||||
|
||||
> ** 注意⚠️ 新增阈值后还需将阈值与监控对象关联(即设置此阈值对哪些监控有效),这样阈值才会对此监控生效 **。
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
**阈值告警配置完毕,已经被成功触发的告警信息可以在【告警中心】看到。**
|
||||
**若需要将告警信息邮件,微信,钉钉飞书通知给相关人员,可以在【告警通知】配置。**
|
||||
|
||||
其它问题可以通过交流群ISSUE反馈哦!
|
||||
49
home/docs/help/alert_threshold_expr.md
Normal file
49
home/docs/help/alert_threshold_expr.md
Normal file
@@ -0,0 +1,49 @@
|
||||
---
|
||||
id: alert_threshold_expr
|
||||
title: 阈值触发表达式
|
||||
sidebar_label: 阈值触发表达式
|
||||
---
|
||||
|
||||
> 在我们配置阈值告警时,需要配置阈值触发表达式,系统根据表达式和监控指标值计算触发是否告警,这里详细介绍下表达式使用。
|
||||
|
||||
#### 表达式支持的操作符
|
||||
|
||||
```
|
||||
equals(str1,str2)
|
||||
==
|
||||
<
|
||||
<=
|
||||
>
|
||||
>=
|
||||
!=
|
||||
( )
|
||||
+
|
||||
-
|
||||
&&
|
||||
||
|
||||
```
|
||||
|
||||
丰富的操作符让我们可以很自由的定义表达式。
|
||||
注意⚠️ 字符串的相等请用 `equals(str1,str2)` 数字类型的相等判断请用== 或 !=
|
||||
|
||||
#### 支持的环境变量
|
||||
> 环境变量即指标值等支持的变量,用于在表达式中,阈值计算判断时会将变量替换成实际值进行计算
|
||||
|
||||
非固定环境变量:这些变量会根据我们选择的监控指标对象而动态变化,例如我们选择了**网站监控的响应时间指标**,则环境变量就有 `responseTime - 此为响应时间变量`
|
||||
如果我们想设置**网站监控的响应时间大于400时**触发告警,则表达式为 `responseTime>400`
|
||||
|
||||
固定环境变量(不常用):`instance : 所属行实例值`
|
||||
此变量主要用于计算多实例时,比如采集到c盘d盘的`usage`(`usage为非固定环境变量`),我们只想设置**c盘的usage大于80**时告警,则表达式为 `equals(instance,"c")&&usage>80`
|
||||
|
||||
#### 表达式设置案例
|
||||
|
||||
1. 网站监控->响应时间大于等于400ms时触发告警
|
||||
`responseTime>=400`
|
||||
2. API监控->响应时间大于3000ms时触发告警
|
||||
`responseTime>3000`
|
||||
3. 全站监控->URL(instance)路径为 `https://baidu.com/book/3` 的响应时间大于200ms时触发告警
|
||||
`equals(instance,"https://baidu.com/book/3")&&responseTime>200`
|
||||
4. MYSQL监控->status指标组->threads_running(运行线程数)指标大于7时触发告警
|
||||
`threads_running>7`
|
||||
|
||||
若遇到问题可以通过交流群ISSUE交流反馈哦!
|
||||
Reference in New Issue
Block a user