日志规约

规范

以下日志规约摘录自《阿里巴巴Java开发手册》

【强制】应用分类打印

应用错误日志分为 Error、Warn、Info、Debug，将错误日志和业务日志分开存放，便于开发人员查看，命名方式：
${appname}_Error.log、${appname}_Warn.log、${appname}_Info.log、${appname}_Debug.log

【强制】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方式。

说明： logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，
会执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。
正例： （条件） 建设采用如下方式

if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
}

正例： （占位符）

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。

正例： <logger name="com.taobao.dubbo.config" additivity="false">

【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 往上抛出。

正例： logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);

【推荐】谨慎地记录日志。

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

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

【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。

说明： 注意日志输出的级别， error 级别只记录系统逻辑出错、异常或者重要的错误信息。