springboot2整合logback.xml动态修改日志打印级别

时间：2023-11-14 08:23:08

今天找bug烦到了，生产上的日志级别不能修改，非常不利于排查问题，于是想到了动态修改日志打印级别， 因为上一周把项目升级成springboot2，并且使用logback.xml管理日志打印，所以修改也很方便。

1. 在pom.xml引入日志依赖

 <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-logging</artifactId>

        </dependency>

注意： 如果引入了starter依赖，则不用再引入以上依赖，因为starter模块中已经集成日志模块

2. logback.xml文件配置如下

<?xml version="1.0" encoding="UTF-8"?>

<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->

<!-- scan:当此属性设置为true时，配置文档如果发生改变，将会被重新加载，默认值为true -->

<!-- scanPeriod:设置监测配置文档是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。

                 当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->

<!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->

<configuration  scan="true" scanPeriod="1000">

    <contextName>logback</contextName>

    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量。 -->

    <property name="log.path" value="D:/app_log/log" />

    <!--0. 日志格式和颜色渲染 -->

    <!-- 彩色日志依赖的渲染类 -->

    <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}}"/>

    <!--1. 输出到控制台-->

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">

        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->

        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">

            <!--打印debug及以前级别的日志-->

            <level>debug</level>

        </filter>

        <encoder>

            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>

            <!-- 设置字符集 -->

            <charset>UTF-8</charset>

        </encoder>

    </appender>

    <!--2. 输出到文档-->

    <!-- 2.1 level为 DEBUG 日志，时间滚动输出  -->

    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!-- 正在记录的日志文档的路径及文档名 -->

        <file>${log.path}/debug.log</file>

        <!--日志文档输出格式-->

        <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>${log.path}/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.LevelFilter">

            <!--只打印debug级别的日志-->

            <level>debug</level>

            <!--如果把这两行注掉，则会打印debug及以上级别的日志-->

            <!--<onMatch>ACCEPT</onMatch>-->

            <!--<onMismatch>DENY</onMismatch>-->

        </filter>

    </appender>

    <!-- 2.2 level为 INFO 日志，时间滚动输出  -->

    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!-- 正在记录的日志文档的路径及文档名 -->

        <file>${log.path}/info.log</file>

        <!--日志文档输出格式-->

        <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>${log.path}/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>

    <!-- 2.3 level为 WARN 日志，时间滚动输出  -->

    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!-- 正在记录的日志文档的路径及文档名 -->

        <file>${log.path}/warn.log</file>

        <!--日志文档输出格式-->

        <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>${log.path}/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.LevelFilter">

            <level>warn</level>

            <onMatch>ACCEPT</onMatch>

            <onMismatch>DENY</onMismatch>

        </filter>

    </appender>

    <!-- 2.4 level为 ERROR 日志，时间滚动输出  -->

    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!-- 正在记录的日志文档的路径及文档名 -->

        <file>${log.path}/error.log</file>

        <!--日志文档输出格式-->

        <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>${log.path}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>

            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

                <maxFileSize>100MB</maxFileSize>

            </timeBasedFileNamingAndTriggeringPolicy>

            <!--日志文档保留天数-->

            <maxHistory>15</maxHistory>

        </rollingPolicy>

        <!-- 此日志文档只记录ERROR级别的 -->

        <filter class="ch.qos.logback.classic.filter.LevelFilter">

            <level>ERROR</level>

            <onMatch>ACCEPT</onMatch>

            <onMismatch>DENY</onMismatch>

        </filter>

    </appender>

    <!--

        <logger>用来设置某一个包或者具体的某一个类的日志打印级别、

        以及指定<appender>。<logger>仅有一个name属性，

        一个可选的level和一个可选的addtivity属性。

        name:用来指定受此logger约束的某一个包或者具体的某一个类。

        level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，

              还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。

              如果未设置此属性，那么当前logger将会继承上级的级别。

        addtivity:是否向上级logger传递打印信息。默认是true。

        <logger name="org.springframework.web" level="info"/>

        <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>

    -->

    <!--

        使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：

        第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息

        第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：

        【logging.level.org.mybatis=debug logging.level.dao=debug】

     -->

    <!--

        root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性

        level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，

        不能设置为INHERITED或者同义词NULL。默认是DEBUG

        可以包含零个或多个元素，标识这个appender将会添加到这个logger。

    -->

    <!-- 4. 最终的策略 -->

    <!-- 4.1 开发环境:打印控制台-->

    <!--<springProfile name="dev">-->

        <!--<logger name="com.sdcm.pmp" level="debug"/>-->

    <!--</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" />

    </root>

    <!-- 4.2 生产环境:输出到文档

    <springProfile name="pro">

        <root level="info">

            <appender-ref ref="CONSOLE" />

            <appender-ref ref="DEBUG_FILE" />

            <appender-ref ref="INFO_FILE" />

            <appender-ref ref="ERROR_FILE" />

            <appender-ref ref="WARN_FILE" />

        </root>

    </springProfile> -->

</configuration>

3. 接口

import ch.qos.logback.classic.LoggerContext;

import lombok.extern.slf4j.Slf4j;

import org.slf4j.LoggerFactory;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RestController;

/**

 * 使用lombok日志管理框架

 */

@Slf4j

@RestController

public class LogController {

    @GetMapping("update/logLevel")

    public String updateLogLevel() {

        LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();

        // 将项目日志打印级别设置成debug级别，还可以根据包路径进行日志级别设置

        loggerContext.getLogger("root").setLevel(ch.qos.logback.classic.Level.toLevel("debug"));

        return "success";

    }

    /**

     * 测试代码

     */

    @GetMapping("/printLog")

    public void testLogPrint() {

        log.debug("debug");

        log.info("info");

        log.warn("warn");

        log.error("error");

    }

}

4. 启动springboot项目

springboot2整合logback.xml动态修改日志打印级别

springboot默认的日志级别是INFO

5. 测试

调用接口，将项目日志级别改成debug

springboot2整合logback.xml动态修改日志打印级别

然后再调用测试接口

springboot2整合logback.xml动态修改日志打印级别

再看一下debug日志文件

springboot2整合logback.xml动态修改日志打印级别

好， 完成，通过！

相关文章