目录
- 1、选择恰当的日志级别
- 2、日志要打印出方法的入参、出参
- 3、选择合适的日志格式
- 4、遇到if...else...等条件时,每个分支首行都尽量打印日志
- 5、日志级别比较低时,进行日志开关判断
- 6、不能直接使用日志系统(Log4j、Logback)中的 API,而是使用日志框架SLF4J中的API
- 7、建议使用参数占位{},而不是用+拼接
- 8、建议使用异步的方式来输出日志
- 9、不要使用e.printStackTrace()
- 10、异常日志不要只打一半,要输出全部错误信息
- 11、禁止在线上环境开启 debug
- 12、不要记录异常,又抛出异常
- 13、避免重复打印日志
- 14、日志文件分离
- 15、核心功能模块,建议打印较完整的日志
- 16、 springboot整合logback进行日志管理
1、选择恰当的日志级别
常见的日志级别有5种,分别是error、warn、info、debug、trace。日常开发中,我们需要选择恰当的日志级别
序号 | 日志级别 | 描述 |
---|---|---|
1 | error | 错误日志,指比较严重的错误,对正常业务有影响,需要运维配置监控的 |
2 | warn | 警告日志,一般的错误,对业务影响不大,但是需要开发关注 |
3 | info | 信息日志,记录排查问题的关键信息,如调用时间、出参入参等等 |
4 | debug | 用于开发DEBUG的,关键逻辑里面的运行时数据 |
5 | trace | 最详细的信息,一般这些信息只记录到日志文件中 |
trace<debug<info<warn<error
级别排序,从左到右,级别越来越高
- 只有当日志级别大于你设置的日志级别才会输出。设置日志的级别是INFO那么比INFO级别高的日志级别会输出到日志文件或者控制台,比INFO级别低的不会输出
2、日志要打印出方法的入参、出参
我们并不需要打印很多很多日志,只需要打印可以快速定位问题的有效日志。
public String testLogMethod(Document doc, Mode mode){
log.debug(“method enter param:{}”,userId);
String id = "dmjxsy";
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这些比较低的日志级别,必须进行日志级别的开关判断。
- 正例
Persion persion= new Persion (12345L, "18", "男");
if (log.isDebugEnabled()) {
log.debug("userId is: {}", persion.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(TestLog.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 {
int i =1/0;
} catch (Exception e) {
e.printStackTrace();
}
- 正例:
try {
int i =1/0;
} catch (Exception e) {
logger.error("异常信息:{}",e);
}
注意!!!
- printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的,通常排查异常日志不太方便。
- e.printStackTrace()语句产生的字符串记录的是堆栈信息,如果信息太长太多,字符串常量池所在的内存块没有空间了,即内存满了,那么,用户的请求就被卡住。
10、异常日志不要只打一半,要输出全部错误信息
- 反例 1:
try {
int i =1/0;
} catch (Exception e) {
logger.error("异常信息");
}
- 异常e都没有打印出来,所以不知道出了什么类型的异常。
- 反例 2:
try {
int i =1/0;
} catch (Exception e) {
logger.error("异常信息:{}",e.getMessage());
}
- e.getMessage()不会记录详细的堆栈异常信息,只会记录错误基本描述信息,不利于排查问题。
- 正例:
try {
int i =1/0;
} catch (Exception e) {
logger.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、核心功能模块,建议打印较完整的日志
- 我们日常开发中,如果核心或者逻辑复杂的代码,建议添加详细的注释,以及较详细的日志。
16、 springboot整合logback进行日志管理
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 seconds" debug="false">
<contextName>logback</contextName>
<!--1、logback配置在application.yml这样配置会在项目当前路径下产生日志文件LOG_PATH_IS_UNDEFINED和指定路径下生成日志文件-->
<!--<springProperty scope="context" name="logPath" source="logging.path"/>-->
<!--2、这样配置会在项目根路径下产生日志文件LOG_PATH_IS_UNDEFINED和指定路径下产生日志文件-->
<!--<property name="LOG_PATH" value="${LOG_PATH:- }"/>-->
<!--<springProperty scope="context" name="logname" source="spring.application.name"/>-->
<!--3、bootstrap.yml配置logback所需要的参数,只会在指定路径下生成日志文件-->
<springProperty scope="context" name="logPath" source="logging.path"/>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<target>System.out</target>
<!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<!-- 设置字符集 FATAL_FILE-->
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- 时间滚动输出 level为 DEBUG 日志 -->
<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<!--<file>${logPath}/log_debug.log</file>-->
<!--日志文件输出格式-->
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%logger{50}:日志输出者的名字,%msg:日志消息,%n是换行符-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 定义了日志的切分方式,把每一天的日志归档到一个文件中 -->
<fileNamePattern>${logPath}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录debug级别的 -->
<!--<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>debug</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 时间滚动输出 level为 INFO 日志 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<!--<file>${logPath}/log_info.log</file>-->
<!--日志文件输出格式-->
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%logger{50}:日志输出者的名字,%msg:日志消息,%n是换行符-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 定义了日志的切分方式,把每一天的日志归档到一个文件中 -->
<fileNamePattern>${logPath}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录info级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>info</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 时间滚动输出 level为 WARN 日志 -->
<appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<!--<file>${logPath}/log_warn.log</file>-->
<!--日志文件输出格式-->
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%logger{50}:日志输出者的名字,%msg:日志消息,%n是换行符-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志归档 -->
<fileNamePattern>${logPath}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录warn级别的 -->
<!--<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>warn</level>
</filter>-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 时间滚动输出 level为 ERROR 日志 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<!--<file>${logPath}/log_error.log</file>-->
<!--日志文件输出格式-->
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%logger{50}:日志输出者的名字,%msg:日志消息,%n是换行符-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--定义了日志的切分方式,把每一天的日志归档到一个文件中-->
<fileNamePattern>${logPath}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!--用来指定日志文件的上限大小,例如设置为100M-->
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录ERROR级别的 -->
<!--<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!--开发环境:打印到文件
additivity:向上传递,false不传递,true传递,默认true。如果配置了<appender-ref>日志可能重复打印,需要
看日志文件,不是控制台,策略是保存在日志文件,当然也可以设置打印在控制台。不配置<appender-ref>会向上传递,
只在上面打印一次。
-->
<springProfile name="dev">
<logger name="com.benjamin.logback.mapper" level="debug" additivity="true">
<appender-ref ref="DEBUG_FILE"/>
</logger>
</springProfile>
<!--测试环境:打印到文件
additivity:向上传递,false不传递,true传递,默认true。如果配置了<appender-ref>日志可能重复打印,需要
看日志文件,不是控制台,策略是保存在日志文件,当然也可以设置打印在控制台。不配置<appender-ref>会向上传递,
只在上面打印一次。
-->
<springProfile name="qa">
<logger name="com.benjamin.logback.mapper" level="debug">
<appender-ref ref="DEBUG_FILE"/>
</logger>
</springProfile>
<!--生产环境:打印到文件
additivity:向上传递,false不传递,true传递,默认true。如果配置了<appender-ref>日志可能重复打印,需要
看日志文件,不是控制台,策略是保存在日志文件,当然也可以设置打印在控制台。不配置<appender-ref>会向上传递,
只在上面打印一次。
-->
<springProfile name="prod">
<logger name="com.benjamin.logback.mapper" level="debug">
<!--<appender-ref ref="DEBUG_FILE"/>-->
</logger>
</springProfile>
<root level="info">
<!--打印在控制台-->
<appender-ref ref="CONSOLE"/>
<!--打印在文件里面-->
<appender-ref ref="DEBUG_FILE"/>
<appender-ref ref="INFO_FILE"/>
<appender-ref ref="WARN_FILE"/>
<appender-ref ref="ERROR_FILE"/>
<!--<appender-ref ref="EMAIL"/>-->
</root>
</configuration>
参考:https://blog.csdn.net/m0_48983233/article/details/113726342