工作总结:日志打印的15个建议
前言
日志是快速定位问题的好帮手,是撕逼和甩锅的利器!打印好日志非常重要。今天我们来聊聊日志打印的15个好建议~
1. 选择恰当的日志级别
常见的日志级别有5种,分别是error、warn、info、debug、trace。日常开发中,我们需要选择恰当的日志级别,不要反手就是打印info哈~
error:错误日志,指比较严重的错误,对正常业务有影响,需要运维配置监控的;
warn:警告日志,一般的错误,对业务影响不大,但是需要开发关注;
info:信息日志,记录排查问题的关键信息,如调用时间、出参入参等等;
debug:用于开发DEBUG的,关键逻辑里面的运行时数据;
trace:最详细的信息,一般这些信息只记录到日志文件中。
2.日志要打印出方法的入参/出参
我们并不需要打印很多很多日志,只需要打印可以快速定位问题的有效日志。有效的日志,是甩锅的利器!
哪些算得的上有效关键的日志呢?比如说,方法进来的时候,打印入参。再然后呢,在方法返回的时候,就是打印出参,返回值。入参的话,一般就是userId或者bizSeq这些关键信息。正例如下:
public String testLogMethod(Document doc, Mode mode){log.debug(“method enter param:{}”,userId);String id = "666";log.debug(“method exit param:{}”,id);return id;
}
3. 选择合适的日志格式
理想的日志格式,应当包括这些最基本的信息:如当前时间戳(一般毫秒精确度)、日志级别,线程名字等等。在logback日志里可以这么配置:
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n</pattern></encoder>
</appender>
如果我们的日志格式,连当前时间都沒有记录,那连请求的时间点都不知道了?
4. 遇到if...else...等条件时,每个分支首行都尽量打印日志
当你碰到if...else...或者switch这样的条件时,可以在分支的首行就打印日志,这样排查问题时,就可以通过日志,确定进入了哪个分支,代码逻辑更清晰,也更方便排查问题了。
正例:
if(user.isVip()){log.info("该用户是会员,Id:{},开始处理会员逻辑",user,getUserId());//会员逻辑
}else{log.info("该用户是非会员,Id:{},开始处理非会员逻辑",user,getUserId())//非会员逻辑
}
5.日志级别比较低时,进行日志开关判断
对于trace/debug这些比较低的日志级别,必须进行日志级别的开关判断。
正例:
User user = new User(666L, "公众号", "捡田螺的小男孩");
if (log.isDebugEnabled()) {log.debug("userId is: {}", user.getId());
}
因为当前有如下的日志代码:
logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
如果配置的日志级别是warn的话,上述日志不会打印,但是会执行字符串拼接操作,如果symbol
是对象, 还会执行toString()
方法,浪费了系统资源,执行了上述操作,最终日志却没有打印,因此建议加日志开关判断。
6. 不能直接使用日志系统(Log4j、Logback)中的 API,而是使用日志框架SLF4J中的API。
SLF4J 是门面模式的日志框架,有利于维护和各个类的日志处理方式统一,并且可以在保证不修改代码的情况下,很方便的实现底层日志框架的更换。
正例:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;private static final Logger logger = LoggerFactory.getLogger(TianLuoBoy.class);
7. 建议使用参数占位{},而不是用+拼接。
反例:
logger.info("Processing trade with id: " + id + " and symbol: " + symbol);
上面的例子中,使用+
操作符进行字符串的拼接,有一定的性能损耗。
正例如下:
logger.info("Processing trade with id: {} and symbol : {} ", id, symbol);
我们使用了大括号{}
来作为日志中的占位符,比于使用+
操作符,更加优雅简洁。并且,相对于反例,使用占位符仅是替换动作,可以有效提升性能。
8. 建议使用异步的方式来输出日志。
日志最终会输出到文件或者其它输出流中的,IO性能会有要求的。如果异步,就可以显著提升IO性能。
除非有特殊要求,要不然建议使用异步的方式来输出日志。以logback为例吧,要配置异步很简单,使用AsyncAppender就行
<appender name="FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender"><appender-ref ref="ASYNC"/>
</appender>
9. 不要使用e.printStackTrace()
反例:
try{// 业务代码处理
}catch(Exception e){e.printStackTrace();
}
正例:
try{// 业务代码处理
}catch(Exception e){log.error("你的程序有异常啦",e);
}
理由:
e.printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的,通常排查异常日志不太方便。
e.printStackTrace()语句产生的字符串记录的是堆栈信息,如果信息太长太多,字符串常量池所在的内存块没有空间了,即内存满了,那么,用户的请求就卡住啦~
10. 异常日志不要只打一半,要输出全部错误信息
反例1:
try {//业务代码处理
} catch (Exception e) {// 错误LOG.error('你的程序有异常啦');
}
异常e都没有打印出来,所以压根不知道出了什么类型的异常。
反例2:
try {//业务代码处理
} catch (Exception e) {// 错误LOG.error('你的程序有异常啦', e.getMessage());
}
e.getMessage()
不会记录详细的堆栈异常信息,只会记录错误基本描述信息,不利于排查问题。
正例:
try {//业务代码处理
} catch (Exception e) {// 错误LOG.error('你的程序有异常啦', e);
}
11. 禁止在线上环境开启 debug
禁止在线上环境开启debug,这一点非常重要。
因为一般系统的debug日志会很多,并且各种框架中也大量使用 debug的日志,线上开启debug不久可能会打满磁盘,影响业务系统的正常运行。
12.不要记录了异常,又抛出异常
反例如下:
log.error("IO exception", e);
throw new MyException(e);
这样实现的话,通常会把栈信息打印两次。这是因为捕获了MyException异常的地方,还会再打印一次。
这样的日志记录,或者包装后再抛出去,不要同时使用!否则你的日志看起来会让人很迷惑。
13.避免重复打印日志
避免重复打印日志,酱紫会浪费磁盘空间。如果你已经有一行日志清楚表达了意思,避免再冗余打印,反例如下:
if(user.isVip()){log.info("该用户是会员,Id:{}",user,getUserId());//冗余,可以跟前面的日志合并一起log.info("开始处理会员逻辑,id:{}",user,getUserId());//会员逻辑
}else{//非会员逻辑
}
如果你是使用log4j日志框架,务必在log4j.xml
中设置 additivity=false,因为可以避免重复打印日志
正例:
<logger name="com.taobao.dubbo.config" additivity="false">
14.日志文件分离
我们可以把不同类型的日志分离出去,比如access.log,或者error级别error.log,都可以单独打印到一个文件里面。
当然,也可以根据不同的业务模块,打印到不同的日志文件里,这样我们排查问题和做数据统计的时候,都会比较方便啦。
15. 核心功能模块,建议打印较完整的日志
我们日常开发中,如果核心或者逻辑复杂的代码,建议添加详细的注释,以及较详细的日志。
日志要多详细呢?脑洞一下,如果你的核心程序哪一步出错了,通过日志可以定位到,那就可以啦。
-- end--
往期推荐
40 个 SpringBoot 常用注解:让生产力爆表!
聊聊Spring事务失效的12种场景,太坑了
SpringBoot 中 4 大核心组件,你了解多少?
工作总结:日志打印的15个建议相关推荐
- 日志打印的15个建议!血泪啊!
往期热门文章: 1.List中remove()方法的陷阱,被坑惨了! 2.Facebook 全球宕机 6 小时!到底遇到了什么问题?? 3.放弃使用 15 年的 MacOS,我决定换成 Linux! ...
- 工作总结!日志打印的15个建议
1. 选择恰当的日志级别 常见的日志级别有5种,分别是error.warn.info.debug.trace.日常开发中,我们需要选择恰当的日志级别,不要反手就是打印info哈~ error:错误日志 ...
- 关于日志打印的几点建议以及非最佳实践
日志的打印在软件开发过程中必不可少,一般分为两个大类: 操作日志 系统日志 操作日志,主要针对的是用户,例如在Photoshop软件中会记录自己操作的步骤,便于用户自己查看. 系统日志,主要针对的是软 ...
- 关于日志打印的几点建议
日志的打印在软件开发过程中必不可少,一般分为两个大类: 操作日志:主要针对的是用户,例如在Photoshop软件中会记录自己操作的步骤,便于用户自己查看. 系统日志:主要针对的是软件开发人员(包括测试 ...
- aop springboot 传入参数_java相关:springboot配置aop切面日志打印过程解析
java相关:springboot配置aop切面日志打印过程解析 发布于 2020-3-31| 复制链接 摘记: 这篇文章主要介绍了springboot配置aop切面日志打印过程解析,文中通过示例代码 ...
- java占位符打印_java简单日志打印规范小记
个人认为,如果公司一些基础类库不做约束,很可能"埋坑",形成技术债务,最终为此付出代价.本文讲解一个最基本的日志打印规范. 1. 日志打印组件 日志组件有很多,日志门面的选择有:S ...
- 日志打印、main函数中代码执行顺序
文章目录 1.设置时区 2.日志打印 3.main函数中代码执行顺序 1.设置时区 我们要设置成 CST 时区,以保证正确地显示日期.时间. 我们常看到的时区有如下几个: PST:美国太平洋标准时间, ...
- 从零构建通讯器--4.3日志打印实战,捋下main函数的调用顺序
文章目录 一:基础设施之日志打印实战代码一 (1)新文件 (2)(//ngx_log_stderr() :三个特殊文件描述符[三章七节] (3)printf的例子说明 (4)ngx_log_stder ...
- Android日志打印框架xLog超详细使用详解
在开发过程中必不可少的会用到Logcat去调试程序.正式上线后一般也还得保存手机用户的操作日志或异常日志方便开发人及时确定问题.我前几天发现一个好用的日志框架--XLog,它可以打印出好看的日志格式方 ...
最新文章
- c语言中成绩等级流程图画法,大家帮我看看这个程序的流程图怎么画,谢了
- ant 编译java 项目_使用ant编译打包、部署简单的javaweb项目 --01
- 【渝粤题库】国家开放大学2021春3700汽车电工电子基础题目
- ajax传递数组:属性traditional设置
- MyBatis:模糊查询的4种实现方式
- mysql 查看数据库字段是否存在,mysql查询某张表是否存在某个字段和判断是否存在某个表名...
- RobotFramework Library
- 文件操作03 - 零基础入门学习C语言62
- 世人都晓AI好 AI芯片知多少?
- C++primer 16.1.2节练习
- 9月1日起施行《中华人民共和国数据安全法》发布(附全文
- 关于ORACLE (AMERICAN_AMERICA.US7ASCII)字符集
- 微信小程序开发:腾讯地图集成步骤(旧题新说)
- 一个bat病毒分析(part1)
- 嵌入式linux/鸿蒙开发板(IMX6ULL)开发流程(六)烧写整个系统或更新部分系统
- 2017.02.18 这一周的面试
- 检索 COM 类工厂中 CLSID 为 {00024500-0000-0000-C000-000000000046} 的组件时失败,原因是出现以下错误: 80070005
- MongoDB在58同城的应用实践
- 公务员考试——申论1
- 为什么EDA软件对芯片设计如此重要?
热门文章
- c# mvvm模式获取当前窗口_AWTK-MVVM 介绍
- 【手把手 脑把脑】教会你使用idea基于MapReduce的统计数据分析(从问题分析到代码编写)
- Spark-大规模数据处理计算引擎
- 新手教程:不写JS,在MIP页中实现异步加载数据
- 安装 Docker Machine
- 搭建基于C#和 Appium 的 Android自动测试环境
- EMC VMAX的磁盘构成,fast policy(重要)
- 2_C语言中的数据类型 (四)整数与无符号数
- Android控件第6类——杂项控件
- 蓝牙芯片排行_7月TWS 全球品牌出货量排行榜出炉