Spring Boot 2动态修改日志级别

做为程序猿，定位问题是咱们的平常工做，而日志是咱们定位问题很是重要的依据。传统方式定位问题时，每每是以下步骤：

•将日志级别设低，例如 DEBUG ；

•重启应用；•复现问题，观察日志；

若是能动态修改日志级别（无需重启应用，就能马上刷新），那绝对如虎添翼。事实上，从 Spring Boot 1.5 开始，Spring Boot Actuator 组件就已提供动态修改日志级别的能力。

编码

1.加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

    这里的 spring-boot-starter-web 不是必须的，只是下面测试代码要用到。

2.写代码

package com.itmuch.logging;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
 
/**
 * @author itmuch.com
 */
@RestController
public class TestController {
    private static final Logger LOGGER = LoggerFactory.getLogger(TestController.class);
 
    @GetMapping("/test")
    public String simple() {
        LOGGER.debug("这是一个debug日志...");
        return "test";
    }
}

3.写配置

management:
  endpoints:
    web:
      exposure:
        include: 'loggers'

因为Spring Boot 2.x默认只暴露 /health 以及 /info 端点，而日志控制须要用到 /loggers 端点，故而须要设置将其暴露。

代码编写完成啦。

测试

    /loggers 端点提供了 查看 以及 修改 日志级别的能力。

测试1：查看当前应用各包/类的日志级别

{
    "levels": ["OFF", "ERROR", "WARN", "INFO", "DEBUG", "TRACE"],
    "loggers": {
        "ROOT": {
            "configuredLevel": "INFO",
            "effectiveLevel": "INFO"
        },        
        "com.itmuch.logging.TestController": {
            "configuredLevel": null,
            "effectiveLevel": "INFO"
        }
    }
    // ...省略
}

测试2：查看指定包/类日志详情

{"configuredLevel":null,"effectiveLevel":"INFO"}

    由测试不难发现，想看哪一个包/类的日志，只需构造 /actuator/loggers/包名类名全路径 去访问便可。

测试3：修改日志级别

    在 TestController 类中，笔者编写设置了一条日志 LOGGER.debug("这是一个debug日志..."); ，而由测试1，默认的日志级别是INFO，因此不会打印。下面来尝试将该类的日志级别设为DEBUG。

    

修改完了之后再次访问那个端点，发现日志级别已经被修改为功了

原理分析

    Actuator有约定， /actuator/xxx 端点的定义代码在 xxxEndpoint 中。故而，找到类 org.springframework.boot.actuate.logging.LoggersEndpoint ，可看到相似以下的代码：

    

@Endpoint(id = "loggers")
public class LoggersEndpoint {
    private final LoggingSystem loggingSystem;
 
    @WriteOperation
    public void configureLogLevel(@Selector String name,
            @Nullable LogLevel configuredLevel) {
        Assert.notNull(name, "Name must not be empty");
        this.loggingSystem.setLogLevel(name, configuredLevel);
    }
    // ...其余省略
}

    

其中， Endpoint 、WriteOperation 、@Selector 都是Spring Boot 2.0开始提供的新注解。

@Endpoint(id = "loggers") 用来描述Spring Boot Actuator 的端点，这样就会产生一个/actuator/loggers 的路径，它相似于Spring MVC的 @RequestMapping("loggers") 。

@WriteOperation 表示这是一个写操做，它相似于Spring MVC的 @PostMapping 。Spring Boot Actuator还提供了其余操做，以下表：

Operation	HTTP method
@ReadOperation	GET
@WriteOperation	POST
@DeleteOperation	DELETE

@Selector 用于筛选 @Endpoint 注解返回值的子集，它相似于Spring MVC的 @PathVariable 。

这样，上面的代码就很好理解了—— configureLogLevel 方法里面就一行代码 ：this.loggingSystem.setLogLevel(name, configuredLevel); ，发送POST请求后，name就是咱们传的包名或者类名，configuredLevel就是咱们传的消息体。

怎么实现动态修改的呢？不妨点进去看看，而后发现代码以下：

// org.springframework.boot.logging.LoggingSystem#setLogLevel
public void setLogLevel(String loggerName, LogLevel level) {
    throw new UnsupportedOperationException("Unable to set log level");
}

嘿嘿，没事，确定有实现类， 该方法在以下实现类被实现：

# 适用于java.util.logging的LoggingSystem
org.springframework.boot.logging.java.JavaLoggingSystem
# 适用于Log4j 2的LoggingSystem
org.springframework.boot.logging.log4j2.Log4J2LoggingSystem
# 适用于logback的LoggingSystem
org.springframework.boot.logging.logback.LogbackLoggingSystem
# 啥都不干的LoggingSystem
org.springframework.boot.logging.LoggingSystem.NoOpLoggingSystem

Spring Boot 2.x中，默认使用Logback，所以进入到 LogbackLoggingSystem 中，代码以下：

@Override
    public void setLogLevel(String loggerName, LogLevel level) {
        ch.qos.logback.classic.Logger logger = getLogger(loggerName);
        if (logger != null) {
            logger.setLevel(LEVELS.convertSystemToNative(level));
        }
    }

至此，就真相大白了。其实根本没有黑科技，Spring Boot本质上仍是使用了Logback的API，ch.qos.logback.classic.Logger.setLevel 实现日志级别的修改。