(轉(zhuǎn)載) 微博 Qzone 微信 Spring Boot 2動態(tài)修改日志級別

作為程序猿席吴,定位問題是我們的日常工作赌结,而日志是我們定位問題非常重要的依據(jù)捞蛋。傳統(tǒng)方式定位問題時,往往是如下步驟:

將日志級別設(shè)低柬姚,例如 DEBUG 拟杉;

重啟應(yīng)用;

復(fù)現(xiàn)問題量承,觀察日志搬设;

如果能動態(tài)修改日志級別(無需重啟應(yīng)用,就能立刻刷新)撕捍,那絕對 如貓?zhí)硪?拿穴。事實上,從 Spring Boot 1.5 開始忧风,Spring Boot Actuator 組件就已提供動態(tài)修改日志級別的能力贞言。

TIPS

其實更低版本也只需簡單擴(kuò)展,即可實現(xiàn)動態(tài)修改日志級別阀蒂。

對Spring Boot Actuator感到陌生的童鞋,可先前往 Spring Boot Actuator( http://www.itmuch.com/spring-cloud/finchley-3/ ) 了解基礎(chǔ)用法弟蚀。

廢話不多說了蚤霞,亮代碼吧。

編碼

1 加依賴

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-actuator

這里的 spring-boot-starter-web 不是必須的义钉,只是下面測試代碼要用到昧绣。

2 寫代碼

package com.itmuch.logging;

?

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RestController;

?

?

/**

* @author itmuch.com

*/

@RestController

public class TestController {

private static final Logger LOGGER = LoggerFactory.getLogger(TestController.class);

?

@GetMapping("/test")

public String simple() {

LOGGER.debug("這是一個debug日志...");

return "test";

}

}

?

3 寫配置:

management:

endpoints:

web:

exposure:

include: 'loggers'

由于Spring Boot 2.x默認(rèn)只暴露 /health 以及 /info 端點,而日志控制需要用到 /loggers 端點捶闸,故而需要設(shè)置將其暴露夜畴。

代碼編寫完成啦。

測試

/loggers 端點提供了 查看 以及 修改 日志級別的能力删壮。

測試1:查看當(dāng)前應(yīng)用各包/類的日志級別贪绘。

訪問 http://localhost:8080/actuator/loggers ,可看到類似如下的結(jié)果:

{

"levels": ["OFF", "ERROR", "WARN", "INFO", "DEBUG", "TRACE"],

"loggers": {

"ROOT": {

"configuredLevel": "INFO",

"effectiveLevel": "INFO"

},

"com.itmuch.logging.TestController": {

"configuredLevel": null,

"effectiveLevel": "INFO"

}

}

// ...省略

}

測試2:查看指定包/類日志詳情

訪問 http://localhost:8080/actuator/loggers/com.itmuch.logging.TestController 央碟,可看到類似如下的結(jié)果:

{"configuredLevel":null,"effectiveLevel":"INFO"}

由測試不難發(fā)現(xiàn)税灌,想看哪個包/類的日志,只需構(gòu)造 /actuator/loggers/包名類名全路徑 去訪問即可亿虽。

測試3:修改日志級別

在 TestController 類中菱涤,筆者編寫設(shè)置了一條日志 LOGGER.debug("這是一個debug日志..."); ,而由測試1洛勉,默認(rèn)的日志級別是INFO粘秆,所以不會打印。下面來嘗試將該類的日志級別設(shè)為DEBUG收毫。

curl -X POST http://localhost:8080/actuator/loggers/com.itmuch.logging.TestController \

-H "Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8" \

--data '{"configuredLevel":"debug"}'

如上攻走,只需發(fā)送一個POST請求殷勘,并將請求body設(shè)為:{"configuredLevel":"debug"} 即可。

此時陋气,訪問 localhost:8080/test 會看到類似如下的日志:

2019-03-28 16:24:04.513 DEBUG 19635 --- [nio-8080-exec-7] com.itmuch.logging.TestController : 這是一個debug日志...

并且劳吠,此時再訪問 http://localhost:8080/actuator/loggers/com.itmuch.logging.TestController ,可看到類似如下的結(jié)果:

{"configuredLevel":"DEBUG","effectiveLevel":"DEBUG"}

說明已成功動態(tài)修改日志級別巩趁。

原理分析

TIPS

本節(jié)著重分析如何實現(xiàn)動態(tài)修改痒玩。

Actuator有約定, /actuator/xxx 端點的定義代碼在 xxxEndpoint 中议慰。故而蠢古,找到類 org.springframework.boot.actuate.logging.LoggersEndpoint ,可看到類似如下的代碼:

@Endpoint(id = "loggers")

public class LoggersEndpoint {

private final LoggingSystem loggingSystem;

?

@WriteOperation

public void configureLogLevel(@Selector String name,

@Nullable LogLevel configuredLevel) {

Assert.notNull(name, "Name must not be empty");

this.loggingSystem.setLogLevel(name, configuredLevel);

}

// ...其他省略

}

其中别凹, Endpoint 草讶、WriteOperation 、@Selector 都是Spring Boot 2.0開始提供的新注解炉菲。

@Endpoint(id = "loggers") 用來描述Spring Boot Actuator 的端點堕战,這樣就會產(chǎn)生一個/actuator/loggers 的路徑,它類似于Spring MVC的 @RequestMapping("loggers") 拍霜。

@WriteOperation 表示這是一個寫操作嘱丢,它類似于Spring MVC的 @PostMapping 。Spring Boot Actuator還提供了其他操作祠饺,如下表:

OperationHTTP method@ReadOperationGET@WriteOperationPOST@DeleteOperationDELETE

@Selector 用于篩選 @Endpoint 注解返回值的子集越驻,它類似于Spring MVC的 @PathVariable 。

這樣道偷,上面的代碼就很好理解了—— configureLogLevel 方法里面就一行代碼 :this.loggingSystem.setLogLevel(name, configuredLevel); 缀旁,發(fā)送POST請求后,name就是我們傳的包名或者類名勺鸦,configuredLevel就是我們傳的消息體并巍。

怎么實現(xiàn)動態(tài)修改的呢?不妨點進(jìn)去看看换途,然后發(fā)現(xiàn)代碼如下:

// org.springframework.boot.logging.LoggingSystem#setLogLevel

public void setLogLevel(String loggerName, LogLevel level) {

throw new UnsupportedOperationException("Unable to set log level");

}

嘿嘿履澳,沒事,肯定有實現(xiàn)類怀跛, 該方法在如下實現(xiàn)類被實現(xiàn):

# 適用于java.util.logging的LoggingSystem

org.springframework.boot.logging.java.JavaLoggingSystem

# 適用于Log4j 2的LoggingSystem

org.springframework.boot.logging.log4j2.Log4J2LoggingSystem

# 適用于logback的LoggingSystem

org.springframework.boot.logging.logback.LogbackLoggingSystem

# 啥都不干的LoggingSystem

org.springframework.boot.logging.LoggingSystem.NoOpLoggingSystem

Spring Boot 2.x中距贷,默認(rèn)使用Logback,因此進(jìn)入到 LogbackLoggingSystem 中吻谋,代碼如下:

@Override

public void setLogLevel(String loggerName, LogLevel level) {

ch.qos.logback.classic.Logger logger = getLogger(loggerName);

if (logger != null) {

logger.setLevel(LEVELS.convertSystemToNative(level));

}

}

至此忠蝗,就真相大白了。其實根本沒有黑科技漓拾,Spring Boot本質(zhì)上還是使用了Logback的API阁最,ch.qos.logback.classic.Logger.setLevel 實現(xiàn)日志級別的修改戒祠。

你可能會好奇

你可能會好奇,LoggingSystem有這么多實現(xiàn)類速种,Spring Boot怎么知道什么情況下用什么LoggingSystem呢姜盈?可在 org.springframework.boot.logging.LoggingSystem 找到類似如下代碼:

public abstract class LoggingSystem {

private static final Map SYSTEMS;

?

static {

Map systems = new LinkedHashMap<>();

systems.put("ch.qos.logback.core.Appender",

"org.springframework.boot.logging.logback.LogbackLoggingSystem");

systems.put("org.apache.logging.log4j.core.impl.Log4jContextFactory",

"org.springframework.boot.logging.log4j2.Log4J2LoggingSystem");

systems.put("java.util.logging.LogManager",

"org.springframework.boot.logging.java.JavaLoggingSystem");

SYSTEMS = Collections.unmodifiableMap(systems);

}

?

/**

* Detect and return the logging system in use. Supports Logback and Java Logging.

* @param classLoader the classloader

* @return the logging system

*/

public static LoggingSystem get(ClassLoader classLoader) {

String loggingSystem = System.getProperty(SYSTEM_PROPERTY);

if (StringUtils.hasLength(loggingSystem)) {

if (NONE.equals(loggingSystem)) {

return new NoOpLoggingSystem();

}

return get(classLoader, loggingSystem);

}

return SYSTEMS.entrySet().stream()

.filter((entry) -> ClassUtils.isPresent(entry.getKey(), classLoader))

.map((entry) -> get(classLoader, entry.getValue())).findFirst()

.orElseThrow(() -> new IllegalStateException(

"No suitable logging system located"));

}

// 省略不相關(guān)內(nèi)容...

}

由代碼不難發(fā)現(xiàn),其實就是構(gòu)建了一個名為 SYSTEMS 的map配阵,作為各種日志系統(tǒng)的字典馏颂;然后在 get 方法中,看應(yīng)用是否加載了map中的類棋傍;如果加載了救拉,就通過反射,初始化響應(yīng) LoggingSystem 瘫拣。例如:Spring Boot發(fā)現(xiàn)當(dāng)前應(yīng)用加載了ch.qos.logback.core.Appender 亿絮,就去實例化 org.springframework.boot.logging.logback.LogbackLoggingSystem 。

界面

本文是使用 curl 手動發(fā)送 POST 請求手動修改日志級別的麸拄,該方式不適用生產(chǎn)派昧,因為很麻煩,容易出錯拢切。生產(chǎn)環(huán)境斗锭,建議根據(jù)Actuator提供的RESTful API定制界面,或使用 Spring Boot Admin 失球,可視化修改日志級別,如下圖所示:

想修改哪個包/類的日志級別帮毁,直接點擊即可实苞。

配套代碼

GitHub:https://github.com/eacdy/spring-boot-study/tree/master/spring-boot-logging-change-logging-level

Gitee:https://gitee.com/itmuch/spring-boot-study/tree/master/spring-boot-logging-change-logging-level

原地址:https://www.toutiao.com/i6673790051039576580/

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市烈疚,隨后出現(xiàn)的幾起案子黔牵,更是在濱河造成了極大的恐慌,老刑警劉巖爷肝,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件猾浦,死亡現(xiàn)場離奇詭異,居然都是意外死亡灯抛,警方通過查閱死者的電腦和手機(jī)金赦,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來对嚼,“玉大人夹抗,你說我怎么就攤上這事∽菔” “怎么了漠烧?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵杏愤,是天一觀的道長。 經(jīng)常有香客問我已脓,道長珊楼,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任度液,我火速辦了婚禮厕宗,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘恨诱。我一直安慰自己媳瞪,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布照宝。 她就那樣靜靜地躺著蛇受,像睡著了一般。 火紅的嫁衣襯著肌膚如雪厕鹃。 梳的紋絲不亂的頭發(fā)上兢仰,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天,我揣著相機(jī)與錄音剂碴,去河邊找鬼把将。 笑死,一個胖子當(dāng)著我的面吹牛忆矛,可吹牛的內(nèi)容都是我干的察蹲。 我是一名探鬼主播,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼催训,長吁一口氣:“原來是場噩夢啊……” “哼洽议!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起漫拭,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤亚兄,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后采驻,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體审胚,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年礼旅,在試婚紗的時候發(fā)現(xiàn)自己被綠了膳叨。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡痘系,死狀恐怖懒鉴,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤临谱,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布璃俗,位于F島的核電站,受9級特大地震影響悉默,放射性物質(zhì)發(fā)生泄漏城豁。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一抄课、第九天 我趴在偏房一處隱蔽的房頂上張望唱星。 院中可真熱鬧,春花似錦跟磨、人聲如沸间聊。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽哎榴。三九已至,卻和暖如春僵蛛,著一層夾襖步出監(jiān)牢的瞬間尚蝌,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工充尉, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留飘言,地道東北人。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓驼侠,卻偏偏與公主長得像姿鸿,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子倒源,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,979評論 2 355