2. 日志规约

优质
小牛编辑
130浏览
2023-12-01

1.【强制】 日志文件推荐至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。

2.【强制】 应用中的扩展日志 ( 如打点、临时监控、访问日志等 ) 命名方式:appName-logType-logName . log 。 logType :日志类型,推荐分类有stats / desc / monitor / visit 等 ; logName :日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。

正例: mppserver 应用中单独监控时区转换异常, 如:mppserver-monitor-timeZoneConvert . log

说明:推荐对日志进行分类,错误日志和业务日志尽量分开存放,便于开发人员查看,也便于通过日志对系统进行及时监控。

3.【推荐】 谨慎地记录日志。生产环境禁止输出 debug 日志; 有选择地输出 info 日志; 如果使用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。

说明:大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。 记录日志时请思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?