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

妖狐艹你老母 2021-06-10 20:40 504阅读 0赞

今天找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"?>
    
    
    
    
    <configuration  scan="true" scanPeriod="1000">
        <contextName>logback</contextName>
    
        
        <property name="log.path" value="D:/app_log/log" />
    
        
        
        <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="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                
                <level>debug</level>
            </filter>
            <encoder>
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
                
                <charset>UTF-8</charset>
            </encoder>
        </appender>
    
        
        
        <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>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                
                <level>debug</level>
                
                
                
            </filter>
        </appender>
    
        
        <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>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>info</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <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>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <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>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
    
        
    
        
    
        
        
        
            
        
    
        <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>
    
        
    
    </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项目

![33cbbd4acfd535605ca9794b17f0acd3.png][]

springboot默认的日志级别是INFO

5. 测试

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

![de9cc72386342c4f3c49a0d3f319ecce.png][]

然后再调用测试接口

![cd40f87ab5388c5eb3b6a8d936f63b07.png][]

再看一下debug日志文件

![64381685e3ef02f765feed14508a3b17.png][]

\-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

example2：

package com.chinasofti.cloudeasy.api.web;
     
    import org.slf4j.LoggerFactory;
    import org.springframework.util.StringUtils;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import ch.qos.logback.classic.Level;
    import ch.qos.logback.classic.LoggerContext;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiImplicitParams;
    import io.swagger.annotations.ApiOperation;
    import lombok.extern.slf4j.Slf4j;
     
    @Api(tags = "动态修改日志级别")
    @RequestMapping("api/v1/monitor")
    @RestController
    @Slf4j
    public class LogController {
     
        /**
         * 修改项目日志输出级别
         *
         * @param allLevel 全局日志级别
         * @param singleLevel 某个类日志级别
         * @param singlePath 需要单独设置日志输出级别的类的全限定名（例:com.chinasofti.cloudeasy.api.web.LogController）
         * @return
         */
        @ApiOperation(value = "changeLogLevel")
        @GetMapping("changeLevel")
        @ApiImplicitParams({
                @ApiImplicitParam(name = "rootLevel",
                        value = "root,全局级别:ALL,TRACE,DEBUG,INFO,WARN,ERROR,OFF", required = false),
                @ApiImplicitParam(name = "singleLevel",
                        value = "单独设置类日志级别:ALL,TRACE,DEBUG,INFO,WARN,ERROR,OFF", required = false),
                @ApiImplicitParam(name = "singlePath",
                        value = "单独类路径:com.chinasofti.cloudeasy.api.web.LogController",
                        required = false)})
        public String changeLevel(String rootLevel, String singleLevel, String singlePath) {
            LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
            log.warn("set log rootLevel:{},singleLevel:{},singlePath:{}", rootLevel, singleLevel,
                    singlePath);
            if (!StringUtils.isEmpty(rootLevel)) {
                // 设置全局日志级别
                ch.qos.logback.classic.Logger logger = loggerContext.getLogger("root");
                logger.setLevel(Level.toLevel(rootLevel));
            }
     
            if (!StringUtils.isEmpty(singleLevel)) {
                // 设置某个类日志级别-可以实现定向日志级别调整
                ch.qos.logback.classic.Logger vLogger = loggerContext.getLogger(singlePath);
                if (vLogger != null) {
                    vLogger.setLevel(Level.toLevel(singleLevel));
                }
            }
            return "success";
        }
    }

[33cbbd4acfd535605ca9794b17f0acd3.png]: /images/20210527/d98d6ddb96744c22a99ca1fba70b4c10.png
[de9cc72386342c4f3c49a0d3f319ecce.png]: /images/20210527/ad8dd6b37b1b4f5cb36f97ed9d7389d4.png
[cd40f87ab5388c5eb3b6a8d936f63b07.png]: /images/20210527/9ac5783f1c3e4a4885530a2ddc083c64.png
[64381685e3ef02f765feed14508a3b17.png]: /images/20210527/c8836647b0864d2ab13dd21b158384cb.png