Skip to content

Commit a6ef6b8

Browse files
authored
Update customtpl.md
1 parent cfc05ff commit a6ef6b8

1 file changed

Lines changed: 19 additions & 15 deletions

File tree

doc/readme/customtpl.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
1-
## 自定义告警消息模版使用说明
1+
# 自定义告警消息模版使用说明
22

33
--------------------------------------
44

5-
自定义告警消息模版可以支持任意带有WebHook服务的系统接入到PrometheusAlert上。钉钉机器人、企业微信机器人均已经支持@某人的功能。使用时,需要在Url中加入`&at= 1539510xxxx`;如需添加多个@目标,用,号分割即可。此处需注意:钉钉@使用的是手机号码,企业微信机器人@使用的是用户帐号,具体可参考各自说明文档。
5+
自定义告警消息模版可以支持任意带有WebHook服务的系统接入到PrometheusAlert上。
66

7-
新增功能:url参数中 `ddurl、wxurl、fsurl、phone、email、wxuser、wxparty、wxtag、groupid `等可不写,如不写这些参数,则会默认去读取配置文件中的对应参数发送消息
7+
#### 钉钉机器人、企业微信机器人均已经支持@某人的功能。使用时,需要在Url中加入`&at= 1539510xxxx`;如需添加多个@目标,用,号分割即可。此处需注意:钉钉@使用的是手机号码,企业微信机器人@使用的是用户帐号。
88

9-
使用该功能需要使用者对go语言的template模版有一些初步了解,可以参考默认模版的一些语法来进行自定义。
9+
#### 新增功能:url参数中 `ddurl、wxurl、fsurl、phone、email、wxuser、wxparty、wxtag、groupid `等可不写,如不写这些参数,则会默认去读取配置文件中的对应参数发送消息
1010

11-
模版数据等信息均存储在程序目录的下的`db/PrometheusAlertDB.db`
11+
#### 使用该功能需要使用者对go语言的template模版有一些初步了解,可以参考默认模版的一些语法来进行自定义
1212

13-
1.下面以添加Prometheus的自定义告警消息模版为例讲解如何添加自定义模版
13+
#### 模版数据等信息均存储在程序目录的下的`db/PrometheusAlertDB.db`中。
14+
15+
## 自定义模板使用
16+
17+
### 1.下面以添加Prometheus的自定义告警消息模版为例讲解如何添加自定义模版
1418

1519
- 开始之前,请先临时更改你的Alertmanager的配置,将所有告警信息都转发到PrometheusAlert自定义接口,参考如下:
1620

@@ -28,7 +32,7 @@ route:
2832
receivers:
2933
- name: 'PrometheusAlert'
3034
webhook_configs:
31-
- url: 'http://[YOUR-PrometheusAlert-URL]/prometheusalert' #这里的配置仅在测试时使用,只是为了方便查看接收到的json消息,正式使用请更改为PrometheusAlert模版页面中显示的Url
35+
- url: 'http://[YOUR-PrometheusAlert-URL]/prometheusalert?type=dd&tpl=prometheus-dingding' #这里的配置仅在测试时使用,只是为了方便查看接收到的json消息,正式使用请更改为PrometheusAlert模版页面中显示的Url
3236
```
3337

3438
配置完成后,重启或者reload Alertmanager,是配置生效。
@@ -39,7 +43,7 @@ receivers:
3943
2020/05/21 10:58:17.850 [D] [value.go:460] [1590029897850034963] {"receiver":"prometheus-alert-center","status":"firing","alerts":[{"status":"firing","labels":{"alertname":"TargetDown","index":"1","instance":"example-1","job":"example","level":"2","service":"example"},"annotations":{"description":"target was down! example dev /example-1 was down for more than 120s.","level":"2","timestamp":"2020-05-21 02:58:07.829 +0000 UTC"},"startsAt":"2020-05-21T02:58:07.830216179Z","endsAt":"0001-01-01T00:00:00Z","generatorURL":"https://prometheus-alert-center/graph?g0.expr=up%7Bjob%21%3D%22kubernetes-pods%22%2Cjob%21%3D%22kubernetes-service-endpoints%22%7D+%21%3D+1\u0026g0.tab=1","fingerprint":"e2a5025853d4da64"}],"groupLabels":{"instance":"example-1"},"commonLabels":{"alertname":"TargetDown","index":"1","instance":"example-1","job":"example","level":"2","service":"example"},"commonAnnotations":{"description":"target was down! example dev /example-1 was down for more than 120s.","level":"2","timestamp":"2020-05-21 02:58:07.829 +0000 UTC"},"externalURL":"https://prometheus-alert-center","version":"4","groupKey":"{}/{job=~\"^(?:.*)$\"}:{instance=\"example-1\"}"}
4044
```
4145

42-
- 继续截取日志中的JSON内容,通过任意json格式化工具进行格式化如下
46+
- 继续截取日志中的JSON内容,通过任意[json格式化工具](https://www.bejson.com/)进行格式化如下
4347

4448
```
4549
{
@@ -110,7 +114,7 @@ receivers:
110114
* 添加完自定义模板后,主要一定要点击保存。
111115

112116
---------------------------------------------------------------------
113-
2.继续对新添加的模版进行测试
117+
### 2.继续对新添加的模版进行测试
114118

115119
- 打开PrometheusAlert Dashboard的模版管理页面`AlertTemplate`
116120

@@ -123,7 +127,7 @@ receivers:
123127
- 继续点击模版测试按钮即可对新添加的模版进行测试,如模版没有错误,将会收到对应的钉钉消息,如无法收到钉钉消息,请检查模版是否有什么地方配置错误
124128

125129
----------------------------------------------------------------------
126-
3.自定义告警消息模版接口使用非常简单
130+
### 3.自定义告警消息模版接口使用非常简单
127131

128132
- 打开PrometheusAlert Dashboard的模版管理页面`AlertTemplate`
129133

@@ -140,9 +144,9 @@ receivers:
140144
![dashboard-tpl-list](https://gitee.com/feiyu563/PrometheusAlert/raw/master/doc/dashboard-tpl-list.png)
141145

142146
----------------------------------------------------------------------
143-
4.关于自定义模版函数
147+
## 4.关于自定义模版函数
144148

145-
4.1 `GetCSTtime` 函数仅支持在PrometheusAlert的自定义模版中使用,该函数主要用于强制将时间字段时区从UTC转换到CST
149+
### 4.1 `GetCSTtime` 函数仅支持在PrometheusAlert的自定义模版中使用,该函数主要用于强制将时间字段时区从UTC转换到CST
146150

147151
目前支持两种使用方式:
148152

@@ -198,7 +202,7 @@ receivers:
198202
{{ end }}
199203
```
200204

201-
4.2 `TimeFormat` 函数仅支持在PrometheusAlert的自定义模版中使用,该函数主要用于格式化时间显示
205+
### 4.2 `TimeFormat` 函数仅支持在PrometheusAlert的自定义模版中使用,该函数主要用于格式化时间显示
202206

203207
如下示例将prmetheus的告警时间格式改为:2006-01-02T15:04:05
204208

@@ -226,7 +230,7 @@ receivers:
226230
{{ end }}
227231
```
228232

229-
4.3 `GetTime` 函数仅支持在PrometheusAlert的自定义模版中使用,该函数主要用于将`毫秒或秒`级时间戳转换为时间字符
233+
### 4.3 `GetTime` 函数仅支持在PrometheusAlert的自定义模版中使用,该函数主要用于将`毫秒或秒`级时间戳转换为时间字符
230234

231235
目前支持两种使用方式:
232236

@@ -270,4 +274,4 @@ preTriggerLevel: {{.PreTriggerLevel}}
270274
ruleId: {{.RuleId}}
271275
dimensions: {{.Dimensions}}
272276
**当前值:{{.CurValue}}**
273-
```
277+
```

0 commit comments

Comments
 (0)