应用平台 APPSTAGE-常用监控插件说明:logalarm
下载应用平台 APPSTAGE用户手册完整版
logalarm
插件类型
ALARM
功能说明
监控指定日志文件，配置日志匹配关键字，并按照配置参数的要求，生成告警并上报到HCW。
参数配置
collect_file_path #定义日志采集配置，按照以下字段，使用json格式数据单行填入。
|
字段ID |
字段名 |
必填 |
类型 |
范围 |
备注 |
|---|---|---|---|---|---|
|
id |
告警定义ID |
是 |
String |
1~128 |
告警ID，由数字、字母、下划线组成。 |
|
alarm_name |
告警名称 |
是 |
String |
1~128 |
支持配置变量{{$log_info}}，上报告警时会替换成匹配到的最后一条ERROR日志；支持配置变量{{$all_matching_log}}，上报告警时会替换成匹配到的所有ERROR日志，当alarm_name配置了变量{{$all_matching_log}}时，若产生告警且后续周期又匹配到了告警，新匹配到的告警会在原告警ID的基础上，产生一个新的告警，并上报到监控系统，告警清除时会清除当前告警和后续产生的告警；当alarm_name配置为空时，会读取文件中的所有内容，逐行检测并上报告警。 |
|
alarm_level |
告警级别 |
是 |
String |
枚举 |
致命critical、严重major、一般minor、提示notice。 不区分大小写。 |
|
key_word |
日志匹配关键字 |
是 |
String |
NA |
日志匹配关键字，支持正则表达式。 |
|
match_file |
日志文件绝对路径 |
是 |
String |
NA |
支持变量、通配符，配置多个地址时需要使用逗号分隔。 |
|
matches |
最大匹配次数 |
是 |
long |
NA |
- |
|
number_of_match_period |
匹配周期数 |
是 |
long |
NA |
与matches和key_word组合使用。 |
|
number_of_nodata_period |
无数据上报的周期数 |
否 |
long |
NA |
单独使用，与matches和key_word无关联。 |
|
description |
告警详情 |
是 |
String |
NA |
进一步丰富告警信息。 |
参数配置样例
[{"id":"alert20240627","alarm_name":"test20240627","alarm_level":"major","key_word":"usr/bin/sudo","match_file":"/var/log/messages","matches":2,"number_of_match_period":"30","number_of_nodata_period":"10","description":"test20240627"}]
# 30个周期内匹配2次以上，则产生告警；30个周期内匹配2次或者2次以下，则清除告警。
# 10个周期内有数据则产生告警，10个周期内无数据上报则清除告警。
