应用平台 APPSTAGE-ALARM类型插件说明:logalarm

时间:2024-04-10 17:20:14

logalarm

功能说明

监控指定日志文件,配置日志匹配关键字,并按照配置参数的要求,生成告警并上报到HCW。

参数配置

collect_file_path #日志文件采集路径

消息样例及含义说明

插件按照配置参数的要求上报日志告警数据,日志告警数据样例:

{
    "id": "Log_030104014395",                        #单位:  | 类型:string  | 说明:告警ID
    "use_custom_id":""                               #单位:  | 类型:string  | 说明:是否使用用户自定义告警ID   
    "alarm_name": "Interface getSC() success rate abnormal",    #单位:  | 类型:string  | 说明:告警名称(支持配置变量{{$log_info}},上报告警时会替换成匹配到的最后一条ERROR日志;支持配置变量{{$all_matching_log}},上报告警时会替换成匹配到的所有ERROR日志,当alarm_name配置了变量{{$all_matching_log}}时,若产生告警且后续周期又匹配到了告警,新匹配到的告警会在原告警ID的基础上,产生一个新的告警,并上报到监控系统,告警清除时会清除当前告警和后续产生的告警;当alarm_name配置为空时,会读取文件中的所有内容,逐行检测并上报告警。)
    "alarm_level": "critical",                       #单位:  | 类型:string  | 说明:告警级别(notice 提示、minor 一般、major 严重、critical 致命)
    "key_word": "-ERROR .*getSC",                    #单位:  | 类型:string  | 说明:日志匹配关键字,支持正则表达式
    "match_file": "/opt/huawei/test/error.log",      #单位:  | 类型:string  | 说明:日志文件绝对路径,支持变量、通配符,配置多个地址时需要使用逗号分隔
    "matches": 2,                                    #单位:  | 类型:long   | 说明:最大匹配次数
    "number_of_match_period": 30,                    #单位:  | 类型:long   | 说明:匹配周期数,与matches和key_word组合使用(30个周期内匹配2次以上,则产生告警;30个周期内匹配2次或者2次以下,则清除告警。)
    "number_of_nodata_period": 10,                   #单位:  | 类型:long   | 说明:无数据上报的周期数, 单独使用,与matches和key_word无关联(10个周期内有数据则产生告警,10个周期内无数据上报则清除告警。)
    "description": "test"                            #单位:  | 类型:string  | 说明:告警详情,进一步丰富告警信息
}
support.huaweicloud.com/usermanual-appstage/appstage_04_1253.html