GaussDB-告警对接配置
操作场景
- 当需要与某告警平台对接或需要对告警平台对接参数值进行调整或修改时,通过实例告警对接配置页面可完成操作。用户可以选择不同的告警对接方式获取实例产生的告警信息,提供Syslog、SNMPv3、HTTPS三种告警对接方式。
- 测试连接通过后,如果有用户选择的告警信息产生,将会通过不同的方式发送到相应平台上。
- 配置告警对接是实例级别的配置,仅对当前选择的实例生效。
前提条件
- 至少管理一个实例。
- 选择告警对接方式为Syslog:需要有一个已安装Syslog服务器的节点,才能进行Syslog告警对接的设置。当前Syslog协议基于TCP协议传输,在对接配置时会使用ping命令校验连通性,需配置打开对应端口并且云数据库GaussDB管理平台(TPOPS)任一节点能ping通该Syslog服务器后,再进行对接配置。
- 选择告警对接方式为SNMPv3:需要有一个已安装SNMPv3服务器的节点,才能进行SNMPv3告警对接的设置。当前SNMPv3协议基于UDP协议传输,需配置打开对应端口后,再进行对接配置。
- 选择告警对接方式为HTTPS:需要有一个可提供HTTPS接口的平台服务器,且能够对云数据库GaussDB管理平台(TPOPS)开放,才能进行HTTPS告警对接的设置。
操作步骤
-
单击具体实例名称,进入“实例管理”详情页。
-
选择“配置管理 > 告警配置 > 告警对接配置”,显示“告警对接配置”页面。
图1 告警对接配置
-
选定需要的“对接方式”,单击开启“告警对接”。
-
显示相应告警对接方式的具体参数设置。
云数据库GaussDB管理平台(TPOPS)提供Syslog、SNMPv3和HTTPS三种告警对接方式,用户可根据实际情况任选一种。
云数据库GaussDB管理平台(TPOPS)支持告警对接的消息内容样式的配置,可通过添加告警模板,分别配置告警触发与告警恢复的消息内容。
-
Syslog告警对接方式
图2 Syslog告警对接方式
参数名称 配置原则 举例 SSL证书 可选择启用SSL安全协议对接告警,启用SSL安全协议需要选择SSL证书用于认证对接告警的Syslog服务器。SSL证书可在“平台管理 > SSL证书管理”页面上传。 - Syslog告警服务IP 该参数用于指定对端的Syslog服务器IP地址。目前只支持IPv4。 10...* Syslog告警服务端口 Syslog服务器端口号。支持的端口范围为1~65535。 514 推送告警数 推送告警的数量。告警数量1到100。 10 告警模板 上报告警时使用的模板。 - 恢复模板 告警恢复时使用的模板。 - 告警级别 满足勾选级别的告警才会被发出。 - 同一告警停发间隔 相同的告警,在停发间隔内再次上报,会被忽略,不会发出告警通知。可设置值有0秒、30秒、1分钟、5分钟、15分钟、30分钟、1小时、3小时、6小时、12小时、1天。 1分钟 -
SNMPv3对接方式
图3 SNMPv3对接方式
参数名称 配置原则 示例 IP地址 输入已安装SNMP服务器的IP地址。只支持IPv4。 10.5.12.11 端口 输入已安装的SNMP服务器的端口号。此处的端口号必须与IP地址一一对应。 1161 用户名 对接服务器创建的SNMP用户名。 - 密码 对接的SNMP服务端的SNMP用户的密码。 - 认证协议 选择以下任意一项:- SHA - MD5
- SHA224
- SHA256
- SHA384
- SHA512 | SHA,对接服务器SNMP用户的认证协议 | | 数据加密协议 | 选择以下任意一项:- CFB_AES_128
- CFB_AES_192
- CFB_AES_256
- CBC_3DES | CFB_AES_256,对接服务器告警消息数据加密协议 | | 数据加密密码 | 对接服务器SNMP用户的加密密码。 | - | | 告警模板 | 上报告警时使用的模板。 | - | | 恢复模板 | 告警恢复时使用的模板。 | - | | 告警级别 | 满足勾选级别的告警才会被发出。 | - | | 同一告警停发间隔 | 相同的告警,在停发间隔内再次上报,会被忽略,不会发出告警通知。可设置值有0秒、30秒、1分钟、5分钟、15分钟、30分钟、1小时、3小时、6小时、12小时、1天。 | 1分钟 |
- 设置完成后,单击“数据加密密码”后的“测试连接”。出现“测试连接通过,请保存设置。”字样,即为测试成功。测试成功后激活保存按键,可进行配置保存。
- 认证协议SHA、MD5,存在安全隐患,请知悉使用风险。
- 数据加密协议CBC_3DES,存在安全隐患,请知悉使用风险。
- 告警级别,告警模板,恢复模板,同一告警停发间隔配置同Syslog。
-
HTTPS对接方式
图4 HTTPS对接方式
参数名称 配置原则 示例 开启SSL 可选择启用支持SSL安全协议的“https”方式对接告警。若不启用,会使用“http”方式对接告警。 - 代理 已配置支持HTTPS发送的第三方平台服务器。以http/https开头,以端口结尾。 https://10.*.*.*:9090 URL模板 服务器的URL地址,以“/”开头。 /sendSms Header模板 HTTP传输的头部内容(以json格式传入)。 {"Content-Type":"application/json"} Body模板 HTTP以POST或PUT方式传输时的Body内容(仅支持以json对象或者json数组格式传入);变量可以在此处定义然后由自定义脚本进行填充,或者在自定义脚本中直接添加。 {"buzId":"GaussDBAlarm","messageId":"alarmText","templateId":"tmp001","mobile":"13722221111","sign":"$sign"} 自定义脚本 是否使用自定义脚本,若Body模板不满足平台要求,可以通过自定义脚本对模板进行修改、补充。 - 脚本内容 当前支持自定义groovy脚本对Body模板进行修改补充。入参有四个字段:- JSONObject body,为Body模板信息。 - String message,为产生的告警信息。
- JSONObject json,为message解析后的JSON串。
- List List最后需要发送的消息信息,需要将修改的body添加到List中。 | - | | 请求响应校验 | 对请求的响应值进行校验。默认采用正则匹配,比如:- retCode对应返回值为0或1表示请求成功,使用'{"retCode":"0|1"}'。
- 支持使用等值判断,针对特殊的返回值比如"0|1",使用'{"retCode_eQs":"0|1"}',避免直接使用正则时产生误判。
- 支持多个条件进行校验,需多个条件同时满足才能通过校验。
- 支持单字符匹配,比如:"ok"。 | {"retCode":0}{"retCode":"0|1"}{"retCode_eQs":"0|1"}{"retCode":0,"status":"success"}"ok" | | 请求方式 | HTTP传输的请求方式,选择以下任意一项:- POST
- GET
- PUT | - | | 告警模板 | 上报告警时使用的模板。 | - | | 恢复模板 | 告警恢复时使用的模板。 | - | | 告警级别 | 满足勾选级别的告警才会被发出。 | - | | 同一告警停发间隔 | 相同的告警,在停发间隔内再次上报,会被忽略,不会发出告警通知。可设置值有0秒、30秒、1分钟、5分钟、15分钟、30分钟、1小时、3小时、6小时、12小时、1天。 | 1分钟 |
告警级别,告警模板,恢复模板,同一告警停发间隔配置同Syslog。
HTTPS告警对接配置常用案例见附录HTTPS告警对接配置常用案例。
-
更多详情请参考GaussDB 文档中心:doc.hcs.huawei.com/db/zh-cn/ga…