SpringBoot动态修改Logger的日志级别

本文通过一个SpringBoot应用的TestController演示如何动态修改日志级别。使用Java 17和SpringBoot 2.6.1,介绍了通过接口获取logger并改变其日志等级,以及观察日志级别变化对输出的影响。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

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 修改日志级别的方法 在 Spring Boot 中,可以通过多种方式修改日志级别。以下是几种常见的方法及其具体实现。 #### 方法一:静态配置文件设置日志级别 Spring Boot 支持通过 `application.properties` 或 `application.yml` 文件来静态定义日志级别。这种方式适用于开发阶段或部署前固定日志需求的情况。 ##### 使用 application.properties 配置 ```properties logging.level.root=INFO logging.level.org.springframework.web=DEBUG ``` 上述代码设置了根日志级别为 INFO,并将 `org.springframework.web` 包的日志级别调整为 DEBUG[^1]。 ##### 使用 application.yml 配置 ```yaml logging: level: root: INFO org.springframework.web: DEBUG ``` 此 YAML 片段同样实现了对不同包路径下的日志级别分别设定的功能[^2]。 --- #### 方法二:动态修改日志级别(无需重启应用) 对于生产环境或者需要实时监控的应用场景,推荐使用动态修改日志级别的方案。这通常涉及 Actuator 组件的支持。 ##### 步骤说明 1. **引入 spring-boot-starter-actuator** 在项目的 `pom.xml` 文件中添加如下依赖: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> ``` 2. **启用 /loggers 端点** 默认情况下 `/loggers` 端点不会暴露给外部访问。如果希望允许 HTTP 请求调用,则需进一步开启 Web 端点支持。 在 `application.properties` 中加入以下内容: ```properties management.endpoints.web.exposure.include=loggers ``` 3. **发送请求更改日志级别** 可以通过 POST 请求向 `/actuator/loggers/{loggerName}` 发送 JSON 数据来更新指定 logger日志级别。例如: - 将 `com.example.demo` 的日志级别改为 TRACE: ```bash curl -X POST http://localhost:8080/actuator/loggers/com.example.demo \ -H 'Content-Type: application/json' \ -d '{"configuredLevel": "TRACE"}' ``` 这种方式能够实现在不中断服务的情况下快速切换日志输出强度[^4]。 --- #### 方法三:编程式动态调整日志级别 除了利用内置的 Actuator 工具外,还可以借助 Logback 提供的 API 来手动编写逻辑完成相同目标。 下面展示了一个简单的例子用于演示如何通过 Java 编码形式改变某个特定类别的 logging threshold 值: ```java import ch.qos.logback.classic.Level; import ch.qos.logback.classic.LoggerContext; public class LoggerLevelChanger { public static void setLoggerLevel(String packageName, String logLevel) { LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory(); ch.qos.logback.classic.Logger logger = context.getLogger(packageName); switch(logLevel.toUpperCase()) { case "ERROR": logger.setLevel(Level.ERROR); break; case "WARN": logger.setLevel(Level.WARN); break; case "INFO": logger.setLevel(Level.INFO); break; case "DEBUG": logger.setLevel(Level.DEBUG); break; default : throw new IllegalArgumentException("Invalid Level"); } } } ``` 注意这种方法仅限于采用 SLF4J 和 Logback 结合使用的场合下有效[^3]。 --- ### 总结 以上介绍了三种不同的技术手段用来满足各种实际应用场景的需求——从基础到高级逐步深入探讨了有关于自定义化以及灵活性更高的解决方案。无论是初学者还是资深工程师都能找到适合自己项目特点的最佳实践途径。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值