Monilog
输入“/”快速插入内容
Monilog
Monilog
Monilog
Monilog是自研的一款流量日志+业务监控组件(与公司的监控不冲突不重复)， 它是一款可以帮你自动打印流量出入口(web/feign/http/mq/redis/db/job...)日志并智能监控响应结果是否成功的工具(有了它，遇到问题你便可能秒级定位，你甚至可以不用手动再打日志了)。 它提供了一键接入、prometheus信息上报、grafana看板展示、prometheus告警、日志打印的能力...
日志检索与埋点
提供摘要日志、详情日志、慢操作日志、redis大值等场景的日志埋点。
监控与告警
一方面提供日志告警模版，另一方面支持by成功失败数、慢操作、成功失败率告警
如果线上遇到Monilog引发的问题，可通过Apollo开关快速关闭Monilog功能，
代码块
monilog.enable=false #当出现问题时可以一键关闭所有
monilog.web.enable=false #当出现web监控问题时可以一键关闭监控，其他类似
1.前言
•
Monilog是什么： Monilog是商业中台团队自研的一款流量日志+业务监控组件(与公司的监控不冲突不复复)，是一款 可以帮你自动打印流量出入口日志并智能监控响应结果是否成功的 工具(有了它，遇到问题你便可能秒级定位，你甚至可以不用手动再打日志了)。它提供了 一键接入 、 prometheus信息上报 、 grafana看板展示 、 prometheus告警 、 日志打印的 能力 。
•
用Monilog可以干什么： 当你请求或提供一个rpc服务、http接口、redis、xxljob任务、一个mq消息、或者DB查...时，这个工具能 自动智能识别其返回的结果是否失败或超时 了， 如果返回结果不符合预期，它会帮你打印出ERROR(或WARN)日志以供你对其进行快速监控或告警， 当然你也可以基于Monilog方便的定义自己的日志输出行为。 在此基础上Monilog已经默认提供了一套包含系统指标、业务接口指标的Grafana监控大盘，你可以直接copy一份来快速建立自己的监控大盘。
•
关键词 ： 日志、监控、Promethues监控、监控大盘、自动化日志埋点、告警接入、全链路日志、摘要日志、详情日志、耗时监控、大key监控、业务监控。
2.现状与解决办法
当前公司监控体系存在一些文件，各个监控系统零散，开发/运维需要关注多个系统的多个指标才能有效掌握应用的状况，导致监控体系缺失，无法全面掌握应用的健康度。在以下方面表现尤为突出：
•
编码不规范，各种中间调用缺少日志导致问题排查困难；
•
业务&技术组件监控缺失或不完整；
•
trace断连，导致问题没法排查；
3.QuickStart
3.1添加依赖
•
只需要引入如下maven依赖即可，版本号用最新版本，(最新版本详见 👉 仓库地址 ) （ 请使用最新正式版本，勿用snapshot版本 ）
maven坐标
建议:
◦
请检查应用中是否有自定义traceId的代码，如有请删掉，javakit会自动定义好traceId，手动改写traceId会导致trace不连续！！！
◦
建议不要额外添加spring-boot-starter-actuator依赖，javakit已经间接依赖过spring-boot-starter-actuator了，手动再引入可能javakit定制过的monitor里边的类冲突而导致监控无法上报
◦
另，建议不要配置management.endpoints.web.exposure.include相关信息，javakit已经提供了默认配置。如果手动配置不当也可能导致监控无法上报
3.2指定Springboot配置项(可选)
注： Monilog已经内置了一套完整的默认配置， 一般情况下无须增加额外配置 ，以下是一个比较好的实践示例：
Tips : 所有monilog开头的springboot配置项，都可以基于 Apollo进行动态推送 (要求版本>=1.1.2) ，即使配置文件中原本没有配置某些项，也能在运行期间通过Apollo推送到应用并生效
3.3 配置结果解析策略(按需)
针对接口响应结果的默认解决策略如下：
# 1. 全局默认的响应结果是否成功的判定如下(匹配到任意一个字段值为true，即认为响应结果为“成功”)
$.success,$.succeeded,$.succeed,$.succ,$.code=SUCCESS,$.isOk(),$.isSuccess(),$.getSuccess(),$.isSucceed(),$.getSucceed(),$.isSucceeded(),$.getSucceeded(),$.isSucc(),$.getResult()
# 2. monilog的全局配置文件中针对以上策略，默认增加了 "+$.code==0,$.code==200"两个判断条件，即最终的全局默认结果判定条件为(以下任意匹配结果为true)：
$.code==0,$.code==200,$.success,$.succeeded,$.succeed,$.succ,$.code=SUCCESS,$.isOk(),$.isSuccess(),$.getSuccess(),$.isSucceed(),$.getSucceed(),$.isSucceeded(),$.getSucceeded(),$.isSucc(),$.getResult()
如果以上默认判定结果不能满足业务要求，可以覆写或追加新的条件，方法如下：
在spring的application.properties文件中增加类似如下示例的配置：
例如： monilog.global-default-bool-expr = +msgCode=SUCCESS,status=0 #当结果中的msgCode为SUCCESS或status=0时也认为结果是成功。 注意"+"开头表示在默认策略上追加，否则为覆盖
注意：
针对通过feign或者httpClient调用第三方接口，会区分调用成功与业务成功， 默认业务失败打error日志 ，避免上游调用大量失败而应用自身不感知。如调用响应{code:-1000,msg:"xx校验不通过"}，标识接口调用成功，但是业务响应失败。
monilog默认全局配置 " +$.code==0,$.code==200" ， 标识响应code字段为0或者200时标识响应成功 。
针对feign、httpClient请求，结果解析表达式添加 " +$.status==200" ，标识识别响应status，当其等于200时也认为成功。