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以及對應的級別

  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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM