Spring Boot日誌管理

標籤：doc   common   自訂   輸出   console   log4j   inf   deb   root   

Spring Boot在所有內部日誌中使用Commons Logging，但是預設配置也提供了對常用日誌的支援，如：Java Util Logging，Log4J, Log4J2和Logback。每種Logger都可以通過配置使用控制台或者檔案輸出日誌內容。

格式化日誌

預設的日誌輸出如下：

1	2016-04-13 08:23:50.120 INFO 37397 --- [ main] org.hibernate.Version : HHH000412: Hibernate Core {4.3.11.Final}

輸出內容元素具體如下：

• 時間日期 — 精確到毫秒
• 記錄層級 — ERROR, WARN, INFO, DEBUG or TRACE
• 進程ID
• 分隔字元 — --- 標識實際日誌的開始
• 線程名 — 方括弧括起來（可能會截斷控制台輸出）
• Logger名 — 通常使用原始碼的類名
• 日誌內容

控制台輸出

在Spring Boot中預設配置了ERROR、WARN和INFO層級的日誌輸出到控制台。

我們可以通過兩種方式切換至DEBUG層級：

• 在運行命令後加入--debug標誌，如：$ java -jar myapp.jar --debug
• 在application.properties中配置debug=true，該屬性置為true的時候，核心Logger（包含嵌入式容器、hibernate、spring）會輸出更多內容，但是你自己應用的日誌並不會輸出為DEBUG層級。

多彩輸出

如果你的終端支援ANSI，設定彩色輸出會讓日誌更具可讀性。通過在application.properties中設定spring.output.ansi.enabled參數來支援。

• NEVER：禁用ANSI-colored輸出（預設項）
• DETECT：會檢查終端是否支援ANSI，是的話就採用彩色輸出（推薦項）
• ALWAYS：總是使用ANSI-colored格式輸出，若終端不支援的時候，會有很多幹擾資訊，不推薦使用

檔案輸出

Spring Boot預設配置只會輸出到控制台，並不會記錄到檔案中，但是我們通常生產環境使用時都需要以檔案方式記錄。

若要增加檔案輸出，需要在application.properties中配置logging.file或logging.path屬性。

• logging.file，設定檔案，可以是絕對路徑，也可以是相對路徑。如：logging.file=my.log
• logging.path，設定目錄，會在該目錄下建立spring.log檔案，並寫入日誌內容，如：logging.path=/var/log

記錄檔會在10Mb大小的時候被截斷，產生新的記錄檔，預設層級為：ERROR、WARN、INFO

層級控制

在Spring Boot中只需要在application.properties中進行配置完成日誌記錄的層級控制。

配置格式：logging.level.*=LEVEL

• logging.level：記錄層級控制首碼，*為包名或Logger名
• LEVEL：選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

舉例：

• logging.level.com.didispace=DEBUG：com.didispace包下所有class以DEBUG層級輸出
• logging.level.root=WARN：root日誌以WARN層級輸出

自訂日誌配置

由於Log Service一般都在ApplicationContext建立前就初始化了，它並不是必須通過Spring的設定檔控制。因此通過系統屬性和傳統的Spring Boot外部設定檔依然可以很好的支援日誌控制和管理。

根據不同的日誌系統，你可以按如下規則群組織設定檔名，就能被正確載入：

• Logback：logback-spring.xml, logback-spring.groovy,logback.xml, logback.groovy
• Log4j：log4j-spring.properties, log4j-spring.xml,log4j.properties, log4j.xml
• Log4j2：log4j2-spring.xml, log4j2.xml
• JDK (Java Util Logging)：logging.properties

Spring Boot官方推薦優先使用帶有-spring的檔案名稱作為你的日誌配置（如使用logback-spring.xml，而不是logback.xml）

自訂輸出格式

在Spring Boot中可以通過在application.properties配置如下參數控制輸出格式：

• logging.pattern.console：定義輸出到控制台的樣式（不支援JDK Logger）
• logging.pattern.file：定義輸出到檔案的樣式（不支援JDK Logger）

Spring Boot日誌管理