SpringBoot动态修改Logger的日志级别

springboot默认使用logback作为日志框架。logback提供了获取logger,修改logger日志级别的接口。

这里用一个Controller演示:获取logger,动态修改logger级别

actuator 其实也提供了管理日志的endpoint

环境 & 版本

  • Java17
  • SpringBoot 2.6.1

TestController

package io.springboot.example.web.controller;

import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;

@RestController
@RequestMapping("/log")
public class TestController {
	
	private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(TestController.class);
	
	/**
	 * 测试日志输出
	 */
	@GetMapping("/test")
	public void test() {
		LOGGER.debug("level -- debug");
		LOGGER.info("level -- info");
		LOGGER.warn("level -- warn");
		LOGGER.error("level -- warn");
	}
	
	/**
	 * 获取所有日志记录器以及对应的日志级别
	 * @return
	 */
	@GetMapping(produces = "application/json; charset=utf-8")
	public Object log () {
		
		// 获取到 Logback 的 LoggerContext
		LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
		// 获取系统所有的logger
		List<Map<String, String>> loggers = loggerContext.getLoggerList()
			.stream()
			// 日志记录器太多了, 为了演示这里进行了过滤。仅仅返回当前controller的logger
			.filter(logger -> logger.getName().equals(TestController.class.getName()))
			// 映射为map
			.map(logger -> {
				Map<String, String> retVal = new LinkedHashMap<>();
				// logger名称 & logger有效级别
				retVal.put(logger.getName(), logger.getEffectiveLevel().levelStr);
				return retVal;
			}).collect(Collectors.toList());
		return loggers;
	}
	
	/**
	 * 设置日志级别
	 * @param loggerName	机器记录器名称
	 * @param level			日志级别
	 * @return
	 */
	@GetMapping(path = "/set" ,produces = "text/plain; charset=utf-8")
	public Object set(@RequestParam("logger") String loggerName,
						@RequestParam("level") String level) {
		LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
		
		// 获取logger
		Logger logger = loggerContext.exists(loggerName);
		if (logger == null) {
			return "日志记录器不存在:" + loggerName;
		}

		// 解析level
		Level newLevel = Level.toLevel(level, null);
		if (newLevel == null) {
			return "不是合法的日志级别:" + level; 
		}
		
		// 设置新的level
		logger.setLevel(newLevel);
		
		return "OK";
	}
}

演示

系统启动后默认日志级别为DEBUG

  1. 请求 /log,获取到logger以及对应的级别

  2. 请求 /log/test 在服务控制台输出日志

  3. 请求 /log/set?logger=io.springboot.example.web.controller.TestController&level=INFO 修改日志级别为INFO

  4. 再次请求/log/test 在服务控制台输出日志,DEBUG日志已经不再输出

  5. 查看logger此时的日志级别,请求 /log

2 Likes