SpringBoot动态修改Logger的日志级别

本文通过一个SpringBoot应用的TestController演示如何动态修改日志级别。使用Java 17和SpringBoot 2.6.1,介绍了通过接口获取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以及对应的级别

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

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

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

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


首发:https://springboot.io/t/topic/4432

Spring Boot修改某个类的日志级别有多种方法: - **使用`application.properties`文件**:在Spring Boot应用程序里,运用`application.properties`设置日志级别最为简便,可在文件中添加类似如下配置来修改某个类的日志级别: ```properties logging.level.com.example.demo.SpecificClass=DEBUG ``` 这里的`com.example.demo.SpecificClass`需替换成实际要修改日志级别的类的全限定名,`DEBUG`则是期望设置的日志级别,也可以根据需要替换成`INFO`、`WARN`、`ERROR`等其他日志级别 [^2]。 - **借助配置中心**:Spring Boot在构建Spring容器时,会初始化日志系统`LoggingSystem`,并和如Logback之类的日志组件绑定。通过`LoggingSystem`暴露的`setLogLevel`接口,能忽略底层日志组件的差异来修改日志级别。借助配置中心(如Apollo)的推送功能,应用可以准实时获取所配置的Logger日志级别,然后调用`LoggingSystem#setLogLevel`进行日志级别的设置。示例代码如下: ```java // 获取LoggingSystem实例 LoggingSystem loggingSystem = LoggingSystem.get(ClassLoader.getSystemClassLoader()); // 设置某个类的日志级别 loggingSystem.setLogLevel("com.example.demo.SpecificClass", LogLevel.DEBUG); ``` 同样,`com.example.demo.SpecificClass`要替换为实际类的全限定名,`LogLevel.DEBUG`可按需替换为其他日志级别。除Apollo外,ZK、Nacos、Spring Cloud Config + Spring Cloud Bus等组件也能实现此功能 [^3]。 - **集成日志框架**:在Java Spring Boot中,可通过集成日志框架(例如Logback或Log4j2)实现动态修改日志级别。以集成Logback为例,在`logback.xml`配置文件中添加如下配置: ```xml <logger name="com.example.demo.SpecificClass" level="DEBUG"/> ``` 其中,`com.example.demo.SpecificClass`替换为实际类的全限定名,`DEBUG`可根据需求替换为其他日志级别 [^4]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值