系统支持多种消息通知模式,可及时将当前资产告警情况提供给管理员,目前支持邮箱、短信、钉钉三种通知方式,告警日志类别有:系统日志、流量控制日志、告警日志。
配置邮件通知
1.登录API安全网关。
2.在左侧导航栏选择“通知外送 > 通知接口”,进入通知接口页面。
3.在页面上方选择“通知接口配置”,开始配置邮件发送信息。
4.在弹出的对话框中配置相关信息。
配置项 | 说明 |
---|---|
SMTP服务器 | SMTP服务器的IP或者域名。 |
SMTP服务器端口 | SMTP服务器所用端口。 |
发件人 | 发件人的邮箱。 |
SMTP验证 | 邮箱是否开启SMTP验证。 |
用户名 | 邮箱的用户名。 |
密码 | 与邮箱用户名对应的用户密码。 |
SSL加密 | 选择邮箱是否进行SSL加密。 |
StartTLS加密 | 选择邮箱是否进行StartTLS加密。 |
编码 | 服务器支持的编码方式,主要为:UTF-8、GBK。 以上SMTP服务器相关配置与服务器端设置保持一致即可。 |
5.配置完通知接口后,在“通知接口”页面单击“新增”开始新增通知分组。
配置项 | 说明 |
---|---|
分组名称 | 填写分组名称,只能输入中文字符、字母、数字、“_”、“.”或“-”,长度不超过64。 |
分组说明 | 填写分组描述说明。 |
收件人邮箱 | 填写收件人邮箱,多个用英文逗号分隔。 |
消息发送周期 | 默认30分钟发送一次,可自定义发送时间周期。 |
日志类型 | 系统日志、流量控制日志、告警日志。 |
邮件主题 | 必填,填写推送标题,变量参考填写说明。 |
邮件正文 | 必填,填写推送内容,变量参考填写说明。 |
6.配置完成后,即可发送通知邮件。
配置短信通知
1.登录API安全网关。
2.在左侧导航栏选择“通知外送 > 通知接口”,进入通知接口页面,在页面上方选择“短信”页签。
3.在页面上方选择“通知接口配置”,开始配置短信发送信息。
配置项 | 说明 |
---|---|
发送方式 | 选择短信发送方式,支持Web接口或数据库接口。 |
Web接口 | |
URL | 短信网关的接入URL。 |
请求方法 | 请求方法,支持GET、POST、PUT请求。 |
请求头 | 请求头。可添加多个请求头信息。 |
请求体 | 请求Post参数内容,如果使用Json方式,该值填写Json内容。 可以使用 ${phone} 和 ${content} 两个参数,分别表示手机号码和短信内容。 例:Uid=username&key=password&Mobil=${phone}&Text=${content} |
数据库接口 | |
数据库类型 | 选择数据库的类型,支持MySQL、Oracle、PostgreSQL和SQLServer。 |
数据库IP/域名( | 短信通知接口数据库IP或域名。 |
端口 | 短信通知接口数据库的端口。 |
用户名/密码 | 短信通知接口数据库的用户名和密码。 |
SQL模板 | 可以使用 ${phone} 和 ${content} 两个参数,分别表示手机号码和短信内容。 例:insert into MSG(count,phonenum,content,prionity) values(1,${phone},${content},1) |
5.配置完通知接口后,在“通知接口”页面单击“新增”开始新增通知分组。
配置项 | 说明 |
---|---|
分组名称 | 填写分组名称,只能输入中文字符、字母、数字、“_”、“.”或“-”,长度不超过64。 |
分组说明 | 填写分组描述说明。 |
接受人手机号码 | 填写收件人手机号,多个用英文逗号分隔。 |
消息发送周期 | 默认30分钟发送一次,可自定义发送时间周期。 |
日志类型 | 系统日志、流量控制日志、告警日志。 |
邮件主题 | 必填,填写推送标题,变量参考填写说明。 |
邮件正文 | 必填,填写推送内容,变量参考填写说明。 |
6.配置完成后,即可发送短信。
配置日志外发
日志外送提供Kafka外送功能,Kafka外送模块是 APIG 系统的通用外发功能,支持配置外发接口以及外发任务来管理通过Kafka方式外发,有固定模板供客户选择。通过Kafka外送发送日志的格式可以根据实际的情况进行调整。
1.登录API安全网关。
2.在左侧导航栏选择“通知外送 > 日志外送”,进入Kafka页签。
3.在“外送接口”区域,单击“新增”按钮,开始新增Kafka外送接口。
配置项 | 说明 |
---|---|
名称 | 日志外送接口的名称。必须为中文字符、字母、数字、“_”、“.”或“-”,长度不超过 64 字符。 |
Kafka节点地址 | Kafka服务器的IP(域名)及端口号。例如:192.168.0.1:9200。 |
Kafka主题 | 消息投放到Kafka服务器的主题。 |
Kafka分区 | 消息投放到的Kafka服务器的分区。Kafka服务器通过主题(topic)、分区(partition)和消费组(consumergroup)三个概念灵活适应各种消息场合,通过提升硬件资源利用率提高系统吞吐量。 以上Kafka相关配置与服务器端保持一致即可。 |
审计日志模板 | 设置发送审计日志的模板,具体字段请依据填写说明编辑。 |
操作日志模板 | 设置发送操作日志的模板,具体字段请依据填写说明编辑。 |
告警日志模板 | 设置发送告警日志的模板,具体字段请依据填写说明编辑。 |
流量控制日志模板 | 设置发送流量控制日志的模板,具体字段请依据填写说明编辑。 |
4.配置完成后,选择“外送任务”,开始新增Kafka外送任务。
配置项 | 说明 |
---|---|
任务名称 | 日志外送任务的名称。必须为中文字符、字母、数字、“_”、“.”或“-”,长度不超过 64 字符。 |
日志类型 | 审计日志、操作日志、告警日志、流量控制日志 |
外送接口 | 选择维护好的外送接口 |
满足条件-协议 | 默认全部 |