Spring Boot日志管理
Spring Boot在所有內部日志中使用 Commons Logging ,但是默認配置也提供了對常用日志的支持,如: Java Util Logging , Log4J , Log4J2 和 Logback 。每種Logger都可以通過配置使用控制臺或者文件輸出日志內容。
格式化日志
默認的日志輸出如下:
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級別輸出
自定義日志配置
由于日志服務一般都在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)