Spring Boot 实现在线WebLog、动态设置日志级别（可配合Nacos实现动态刷新）

lakernote
576 阅读3分钟

文章目录

前言

通过前2篇原理剖析我们已经可以模拟造轮子了，本篇内容来实战一波。

在实际项目开发中，一般的业务配置刷新，直接用@RefreshScope+@Value即可，但是我们项目上经常会遇到这样的场景，无法简单的用@RefreshScope+@Value实现，例如：

  • 线上跑的实例配置的日志级别是ERROR级别或者WARN级别；
  • 由于出现了bug，我想动态的改成DEBUG去查看详细的业务日志；
  • 查看完毕后，还要动态的改回之前的ERROR级别或者WARN级别；

想到这儿，很多动态的实战可供探讨，本文旨在抛砖引玉，例如：

  • 动态配置数据源
  • 动态的GateWay网关配置
  • 万物皆可动态配置?

本文参考spring-boot-starter-actuator中的日志相关接口实现功能。

  • LogFileWebEndpoint，实现服务器端日志浏览
  • LoggersEndpoint，实现日志的级别查询以及动态设置

实战

1. 实现服务器端日志浏览

核心代码：

@RestController
@RequestMapping("/log")
public class LogFileWebEndpoint {
    @Value("${laker.log.file.path:./laker.log}")
    String filePathConfig;
    @RequestMapping(value = "/file", produces = "text/plain; charset=UTF-8")
    public Resource logFile(@RequestParam(required = false) String filePath) {
        if (StrUtil.isNotBlank(filePath)) {
            filePathConfig = filePath;
        }
        Resource logFileResource = new FileSystemResource(new File(filePathConfig));
        if (logFileResource == null || !logFileResource.isReadable()) {
            return null;
        }
        return logFileResource;
    }
}

浏览器访问：http://localhost:8080/log/file?filePath=d://a.log

结果如下：

在这里插入图片描述

这里跟动态配置没什么关系，但是这个功能还是蛮实用的，你别跟我说上什么ELK套件，其实大部分场景，压根没几台实例，杀鸡焉用牛刀。

几行代码实现这个在线weblog，瑞士军刀，小而实用它不香吗？

2. 实现日志级别查询

核心代码：

    @Autowired
    private LoggingSystem loggingSystem;
    @Autowired
    private LoggerGroups loggerGroups;
    Logger log = LoggerFactory.getLogger(LogWebEndpoint.class);
    @RequestMapping(value = "/loggers") //返回所有日志以及配置的级别
    public Map<String, Object> loggers() {
        Collection<LoggerConfiguration> configurations = this.loggingSystem.getLoggerConfigurations();
        if (configurations == null) {
            return Collections.emptyMap();
        }
        Map<String, Object> result = new LinkedHashMap<>();
        result.put("levels", getLevels());
        result.put("loggers", getLoggers(configurations));
        result.put("groups", getGroups());
        return result;
    }

浏览器访问：http://localhost:8080/log/loggers

结果如下：

在这里插入图片描述

3. 实现日志的级别动态设置

    @RequestMapping(value = "/level") //动态设置日志级别
    public void configureLogLevel(String name, @Nullable LogLevel configuredLevel) {
        log.debug("name:{},level:{}", name, configuredLevel);
        log.info("name:{},level:{}", name, configuredLevel);
        log.warn("name:{},level:{}", name, configuredLevel);
        log.error("name:{},level:{}", name, configuredLevel);
        LoggerGroup group = this.loggerGroups.get(name);
        if (group != null && group.hasMembers()) {
            group.configureLogLevel(configuredLevel, this.loggingSystem::setLogLevel);
            return;
        }
        this.loggingSystem.setLogLevel(name, configuredLevel);
    }

默认是INFO级别

  • 浏览器请求：http://localhost:8080/log/level?name=com.laker.config&configuredLevel=DEBUG

在这里插入图片描述

  • 浏览器请求：http://localhost:8080/log/level?name=com.laker.config&configuredLevel=ERROR

在这里插入图片描述

从结果可以看出已经动态生效

其他方案：动态态修改日志配置文件

修改logback.xml配置文件：在configuration根节点配置属性scan和scanPeriod，scan为true时，配置文件被修改会被重新加载，scanPeriod定义了扫描文件变化的周期，默认60000毫秒，即一分钟。

<configuration scan="true" scanPeriod="60000">
...
</configuration>

重点来了 ，通过上面的代码和演示我们已经知道动态刷新日志级别核心代码。

loggingSystem.setLogLevel(name, configuredLevel);

再结合着前面讲的Nacos长连接监听远端配置变更，很容易就可以实现动态设置了。
这里给个提示，当有配置刷新的时候，Spring 上下文会发出下面的事件，自己去实现监听者即可。

this.context.publishEvent(new EnvironmentChangeEvent(this.context, keys));

如果有什么疑问，可以加我微信讨论【lakernote】

本系列目录

🍎QQ群【837324215】
🍎关注我的公众号【Java大厂面试官】，一起学习呗🍎🍎🍎
🍎个人vx【lakernote】

avatar
文章
阅读
粉丝