使用 Logback 配置日志记录

前言

• 在开发和运维过程中，日志记录是一个不可或缺的部分。合理的日志配置可以帮助我们快速定位问题、监控系统状态并进行故障排除。本文将详细介绍如何使用 Logback 配置文件来满足特定的日志需求，特别是在使用 BladeX 框架时。

• BladeX 是一个基于 Spring Boot 的微服务框架，广泛应用于企业级应用开发。Logback 是一个强大的日志框架，能够灵活地配置日志输出格式和目的地。本文将展示如何使用 Logback 配置文件来实现彩色日志输出、控制台日志记录、ELK 日志推送等功能。

---

Logback 配置文件详解

基本结构

• Logback 配置文件通常是一个 XML 文件，位于项目的src/main/resources目录下，文件名通常是 logback-prod.xml 或 logback-test.xml。以下是本文使用的 Logback 配置文件的完整示例：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds"><!-- 自定义参数监听 --><contextListener class="org.springblade.core.log.listener.LoggerStartupListener"/><springProperty scope="context" name="springAppName" source="spring.application.name"/><!-- 彩色日志依赖的渲染类 --><conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/><conversionRule conversionWord="wex"converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/><conversionRule conversionWord="wEx"converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/><!-- 彩色日志格式 --><property name="CONSOLE_LOG_PATTERN"value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/><!-- 控制台输出 --><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><pattern>${CONSOLE_LOG_PATTERN}</pattern><charset>utf8</charset></encoder></appender><!-- 条件判断：如果 ELK_MODE 为 TRUE，则推送日志至 ELK --><if condition='property("ELK_MODE").toUpperCase().contains("TRUE")'><then><!-- 推送日志至 ELK --><appender name="STDOUT_LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender"><destination>${DESTINATION}</destination><!-- 日志输出编码 --><encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder"><providers><timestamp><timeZone>UTC</timeZone></timestamp><pattern><pattern>{"traceId": "%X{traceId}","requestId": "%X{requestId}","accountId": "%X{accountId}","tenantId": "%X{tenantId}","logLevel": "%level","serviceName": "${springAppName:-SpringApp}","pid": "${PID:-}","thread": "%thread","class": "%logger{40}","line":"%L","message": "%message"}</pattern></pattern><mdc/><stackTrace/></providers></encoder></appender></then></if><!-- 日志输出级别 --><root level="INFO"><appender-ref ref="STDOUT"/><appender-ref ref="${STDOUT_APPENDER}"/></root><!-- 设置特定 logger 的日志级别 --><logger name="net.sf.ehcache" level="ERROR"/><logger name="druid.sql" level="ERROR"/><logger name="com.apache.ibatis" level="ERROR"/><logger name="org.mybatis.spring" level="ERROR"/><logger name="java.sql.Connection" level="ERROR"/><logger name="java.sql.Statement" level="ERROR"/><logger name="java.sql.PreparedStatement" level="ERROR"/><!-- 减少部分 debug 日志 --><logger name="druid.sql" level="ERROR"/><logger name="org.apache.shiro" level="ERROR"/><logger name="org.mybatis.spring" level="ERROR"/><logger name="org.springframework" level="INFO"/><logger name="org.springframework.context" level="ERROR"/><logger name="org.springframework.beans" level="ERROR"/><logger name="com.baomidou.mybatisplus" level="ERROR"/><logger name="org.apache.ibatis.io" level="ERROR"/><logger name="org.apache.velocity" level="ERROR"/><logger name="org.eclipse.jetty" level="ERROR"/><logger name="io.undertow" level="ERROR"/><logger name="org.xnio.nio" level="ERROR"/><logger name="org.thymeleaf" level="ERROR"/><logger name="springfox.documentation" level="ERROR"/><logger name="org.hibernate.validator" level="ERROR"/><logger name="com.netflix.loadbalancer" level="ERROR"/><logger name="com.netflix.hystrix" level="ERROR"/><logger name="com.netflix.zuul" level="ERROR"/><logger name="de.codecentric" level="ERROR"/><!-- cache INFO --><logger name="net.sf.ehcache" level="ERROR"/><logger name="org.springframework.cache" level="ERROR"/><!-- cloud --><logger name="org.apache.http" level="ERROR"/><logger name="com.netflix.discovery" level="ERROR"/><logger name="com.netflix.eureka" level="ERROR"/><!-- 业务日志 --><logger name="org.springblade" level="ERROR"/><logger name="org.springblade.core.tenant" level="ERROR"/><logger name="org.springblade.core.version" level="ERROR"/><!-- 减少 Nacos 日志 --><logger name="com.alibaba.nacos" level="ERROR"/>
</configuration>

关键配置解析

1. 自定义参数监听

• <contextListener>：用于监听上下文变化，可以在启动时执行一些初始化操作。
• <springProperty>：从 Spring 的配置文件中读取属性值，例如 spring.application.name。

2. 彩色日志

• <conversionRule>：定义日志转换规则，用于渲染彩色日志。
• <property>：定义日志格式，使用颜色编码增强可读性。

3. 控制台输出

• <appender>：定义日志输出器，这里是控制台输出器 ConsoleAppender。
• <encoder>：定义日志编码器，使用 PatternLayoutEncoder 指定日志格式。

4. 条件判断

• <if>：根据环境变量 ELK_MODE 的值决定是否启用 ELK 日志推送。
• <appender>：定义日志输出器，这里是 ELK 日志推送输出器 LogstashTcpSocketAppender。

5. 日志输出级别

• <root>：设置根日志级别，默认为 INFO。
• <appender-ref>：引用日志输出器，这里是控制台输出器 STDOUT。

6. 特定 logger 的日志级别

• <logger>：设置特定 logger 的日志级别，例如 net.sf.ehcache 设置为 ERROR。

常见问题及解决方案

log.info 日志不打印

• 如果您发现 log.info 日志没有打印出来，可能是由于日志级别设置不当。确保根日志级别设置为 INFO 或更低，并且特定 logger 的日志级别也设置为 INFO 或更低。例如：

<root level="INFO"><appender-ref ref="STDOUT"/>
</root><logger name="org.springblade" level="INFO"/>
<logger name="org.springblade.core.tenant" level="INFO"/>
<logger name="org.springblade.core.version" level="INFO"/>

ELK 日志推送配置

• 确保 ELK_MODE 环境变量设置为 TRUE，并且 DESTINATION 属性正确配置了 ELK 服务器的地址。例如：

ELK_MODE: TRUE
DESTINATION: tcp://localhost:5000

---

总结

如果此篇文章有帮助到您, 希望打大佬们能关注、点赞、收藏、评论支持一波，非常感谢大家！
如果有不对的地方请指正!!!