专栏首页JavaEdge阿里Java编码手册实战详解-日志篇

阿里Java编码手册实战详解-日志篇

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

import org.slf4j.Logger; 
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class); 

开发中,我们常使用 Lombko 的@SLFJ 注解.

错误写法

try {
     doSomething();
} catch (Exception e) {
     e.printStackTrace();
}

2. 【强制】所有日志文件至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日志不少于 6 个月。

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

appName_logType_logName.log

  • logType:日志类型,如 stats/monitor/access 等
  • logName:日志描述

这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。

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

正例:force-web 应用中单独监控时区转换异常,如:force_web_timeZoneConvert.log

4. 【强制】在日志输出时,字符串变量之间的拼接使用占位符的方式。 说明:因为 String 字符串的拼接会使用 StringBuilder 的 append()方式,有一定的性能损耗。使用占位符仅是替换动作,可以有效提升性能。

正例

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()方法调用,无谓浪费方法调用的开销。 正例:

// 如果判断为真,那么可以输出 trace 和 debug 级别的日志
if (logger.isDebugEnabled()) {
logger.debug("Current ID is: {} and name is: {}", id, getName());
}

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

正例:

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

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

正例:

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

8. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。 说明: 大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。记录日志时请

思考: 这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?

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

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

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

参考

阿里巴巴Java开发手册(华山版)

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 史上最快! 10小时大数据入门实战(六)- Hadoop 项目实战1 用户行为日志概述离线数据处理架构3 项目需求4 UserAgent 类实现5

    JavaEdge
  • 面试官问我生成器模式(又名建造者模式),还好我都会

    系统中一些复杂的对象,它们拥有多个组成部分,如汽车,它包括车轮、方向盘、发送机等各种部件。而对于大多数用户而言,无须知道这些部件的装配细节,也几乎不会使用单独某...

    JavaEdge
  • Netty源码阅读入门实战(十一) - 设计模式的应用

    JavaEdge
  • 有赞百亿级日志系统架构设计

    日志是记录系统中各种问题信息的关键,也是一种常见的海量数据。日志平台为集团所有业务系统提供日志采集、消费、分析、存储、索引和查询的一站式日志服务。主要为了解决日...

    用户1278550
  • 小记 | 从 0 到 1,看我玩弄千万日志于股掌

    3. 调试程序,和控制台的作用类似,但是控制台中的内容并不会保存到文件中,而日志可以长期保存。

    程序员鱼皮
  • 腾讯云容器服务日志采集最佳实践

    roc,腾讯高级工程师,Kubernetes Contributor,热爱开源,专注云原生领域。目前主要负责腾讯云TKE 的售中、售后的技术支持,根据客户需求...

    腾讯云原生
  • 集中日志系统ELK

    以前都是登陆到每个机器去看日志,特别是一个服务有多个机器集群部署,还要下载多个机器的日志(运维下载日志,然后给开发排查问题),现在elk是集中式日志系统,所有的...

    青乡java
  • 关于日志打印的几点建议

    操作日志,主要针对的是用户,例如在Photoshop软件中会记录自己操作的步骤,便于用户自己查看。

    lyb-geek
  • 日志易:IT 运维分析及海量日志搜索的实践之路(上)

    IT运维分析(IT Operation Analytics, ITOA)是近年兴起的把大数据技术应用于分析IT运维产生的大量数据,数据来源主要有日志、网络流量、...

    日志易
  • Spring Boot系列——日志配置

    日志,通常不会在需求阶段作为一个功能单独提出来,也不会在产品方案中看到它的细节。但是,这丝毫不影响它在任何一个系统中的重要的地位。

    JackieZheng

扫码关注云+社区

领取腾讯云代金券