《Java开发手册》异常日志之日志规约

[复制链接]
查看: 441|回复: 0

16

主题

16

帖子

60

积分

注册会员

Rank: 2

积分
60
发表于 2020-12-11 10:38:13 | 显示全部楼层 |阅读模式
1. 【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架
SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。
  1. import org.slf4j.Logger;
  2. import org.slf4j.LoggerFactory;
  3. private static final Logger logger = LoggerFactory.getLogger(Test.class);
复制代码

2. 【强制】所有日志文件至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。网络
运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日
志不少于 6 个月。
3. 【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:
appName_logType_logName.log。logType:日志类型,如 stats/monitor/access 等;logName:日志
描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归
类查找。
说明:推荐对日志进行分类,如将错误日志和业务日志分开存放,便于开发人员查看,也便于通过日志对
系统进行及时监控。
正例:force-web 应用中单独监控时区转换异常,如:force_web_timeZoneConvert.log
4. 【强制】在日志输出时,字符串变量之间的拼接使用占位符的方式。
说明:因为 String 字符串的拼接会使用 StringBuilder 的 append()方式,有一定的性能损耗。使用占位符
仅是替换动作,可以有效提升性能。
正例:
  1. logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);
复制代码
5. 【强制】对于 trace/debug/info 级别的日志输出,必须进行日志级别的开关判断。
说明:虽然在 debug(参数)的方法体内第一行代码 isDisabled(Level.DEBUG_INT)为真时(Slf4j 的常见实
现 Log4j 和 Logback),就直接 return,但是参数可能会进行字符串拼接运算。此外,如果
debug(getName())这种参数内有 getName()方法调用,无谓浪费方法调用的开销。
正例:
  1. // 如果判断为真,那么可以输出 trace 和 debug 级别的日志
  2. if (logger.isDebugEnabled()) {
  3. logger.debug("Current ID is: {} and name is: {}", id, getName());
  4. }
复制代码

6. 【强制】避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false。
正例:
  1. <logger name="com.taobao.dubbo.config" additivity="false">
复制代码
7. 【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通
过关键字 throws 往上抛出。
正例:
  1. logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);
复制代码
8. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使
用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘
撑爆,并记得及时删除这些观察日志。
说明:大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。记录日志时请思考:这些
日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?
9. 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所
适从。如非必要,请不要在此场景打出 error 级别,避免频繁报警。
说明:注意日志输出的级别,error 级别只记录系统逻辑出错、异常或者重要的错误信息。
10.【推荐】尽量用英文来描述日志错误信息,如果日志中的错误信息用英文描述不清楚的话使
用中文描述即可,否则容易产生歧义。【强制】国际化团队或海外部署的服务器由于字符集
问题,使用全英文来注释和描述日志错误信息。


腾讯云
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

精彩图文



在线客服(工作时间:9:00-22:00)
400-600-6565

内容导航

微信客服

Copyright   ©2015-2019  云服务器社区  Powered by©Discuz!  技术支持:尊托网络     ( 湘ICP备15009499号-1 )