前言
套用网络流行的标题,开始了这篇文章。之前使用Spring Boot,日志一直都是nohup再把标准输出重定向到一个文件里,这样毫无疑问是很low的。于是趁着项目的间歇,照着网上的教程哼哧哼哧的把logback配起来。配完之后,再想想怎么用起来更高大上一点,就给自己提了下面几个问题:
- 不同级别的日志怎么输出到不同的文件?
- 不同服务的日志怎么输出到不同的文件?
- 怎么通过一个traceId把同一次请求里的多条日志串起来?
- 日志的配置怎么在打包时能根据不同的环境去调整?
- 运行中的服务可以动态的调整日志级别么?
为了解决这些问题,就有了文章标题所说的那XX件事。下面将大概介绍下各个问题的解决方案。最终的成果在代码中:
logtest
1.Filter
第一个问题的解决方案,就是使用appender中的Filter。logback支持多种Filter,对于日志级别的过滤使用LevelFilter。
<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{requestId}] [%-5level] [%logger{36}:%line] - [%msg]%n
</pattern>
<charset>UTF-8</charset>
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${LOG_HOME}/${APP_NAME}/debug.log.%d{yyyy-MM-dd}</FileNamePattern>
<MaxHistory>${LOG_KEEP_TIME}</MaxHistory>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
2.logger
之前配置日志总是喜欢把appender都配置在root下,这个是一种全局的配置,其实可以通过logger进一步细化。
<logger name="tactics" additivity="false" level="INFO">
<appender-ref ref="tactics"/>
</logger>
对应的获取logger方法为:
private final Logger tacticsLogger = LoggerFactory.getLogger("tactics");
也可以按照我们惯用的方式:
<logger name="com.qcd.logtest.TacticsLogger" additivity="false" level="INFO">
<appender-ref ref="tactics"/>
</logger>
对应的获取logger方法为:
private final Logger tacticsLogger = LoggerFactory.getLogger(getClass());
logger里面有个很重要的属性additivity,这个属性决定了日志里的内容是否会向上一级日志传递。
3.MDC
对于第三个问题想过自己去封装一个日志工具类,通过ThreadLocal的方式来提供uuid,但是总觉得没那么自然。也看到有人用Spring Cloud Sleuth来达到目的,又觉得太重。后面发现了MDC这个好东西,觉得很满意。
MDC(Mapped Diagnostic Context,映射调试上下文)是 logback 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的哈希表,可以往其中添加键值对。
具体的使用代码可以参考LogInterceptor.java。
其中比较关键的两处如下:
MDC.put("requestId", uuid);
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{requestId}] [%-5level] [%logger{36}:%line] - [%msg]%n
在pattern中使用的[%X{requestId}]就是来自在MDC中存储的uuid。
4.logback-spring.xml
既然加上了spring这么个后缀,肯定会给你好处的。
- 可以拿到application.properties里的配置:
<springProperty scope="context" name="logPath" source="logging.path"/>
<property name="LOG_HOME" value="${logPath}"/>
- 可以拿到使用的profile
<springProfile name="test,dev">
<logger name="com.qcd.logtest.TacticsLogger" level="INFO" />
</springProfile>
<springProfile name="pro">
<logger name="com.qcd.logtest.TacticsLogger" level="ERROR" />
</springProfile>
5.actuator
spring1.5.X版本引入的一个新的控制端点:/loggers,这个端点非常强大,可以查看当前的日志级别,还可以动态修改日志级别。比如要修改LogtestController的日志级别,通过发送POST请求到:
http://localhost:9011/manage/loggers/com.qcd.logtest.controller.LogtestController
请求体为:
{
"configuredLevel": "DEBUG"
}
最后
感谢强大的开源社区,感谢互联网上那些无私奉献的同道!!!