编码规约之日志处理

目录

一、强制

1.应用中不可直接使用日志系统(Log4j、Logback)中的 API

2.日志文件至少保存15 天

3.应用中的扩展日志(如打点、临时监控、访问日志等)命名方式

4.对 trace/debug/info 级别的日志输出注意项

5.避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false

6.异常信息应该包括两类信息:案发现场信息和异常堆栈信息 

二、推荐

1.谨慎地记录日志

2.注意日志输出的级别

3.尽量用英文来描述日志错误信息


一、强制

1.应用中不可直接使用日志系统Log4jLogback中的 API

应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架 SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;

    private static final Logger logger = LoggerFactory.getLogger(Abc.class);

2.日志文件至少保存15 天

日志文件至少保存 15 天,因为有些异常具备以"周"为频次发生的特点。

3.应用中的扩展日志(如打点临时监控访问日志等)命名方式

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

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

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

4.对 trace/debug/info 级别的日志输出注意项

对 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); 

5.避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false

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

6.异常信息应该包括两类信息:案发现场信息异常堆栈信息 

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

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

二、推荐

1.谨慎地记录日志

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

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

2.注意日志输出的级别

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

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

3.尽量用英文来描述日志错误信息

尽量用英文来描述日志错误信息,如果日志中的错误信息用英文描述不清楚的话使用中文描述即可,否则容易产生歧义。国际化团队或海外部署的服务器由于字符集问题,必须使用全英文来注释和描述日志错误信息。

猜你喜欢

转载自blog.csdn.net/mmake1994/article/details/88769005