SpringBoot學(xué)習(xí)筆記四:日志

Spring Boot官方文檔日志部分
https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-logging

Spring Boot使用Commons Logging進(jìn)行所有內(nèi)部日志記錄,但開放了底層日志實(shí)現(xiàn) leaves the underlying log implementation open。為Java Util Logging,Log4J2Logback提供了默認(rèn)配置 。在每種情況下,記錄器都預(yù)先配置為使用控制臺(tái)輸出,并提供可選的文件輸出。

默認(rèn)情況下,如果使用“Starters”,則使用 Logback進(jìn)行日志記錄。還包括適當(dāng)?shù)腖ogback路由,以確保使用Java Util Logging,Commons Logging,Log4J或SLF4J的依賴庫(kù)全部正常工作。

Java有很多可用的日志框架。如果對(duì)上面的列表感到困惑也不用擔(dān)心。一般來說,使用 SpringBoot 默認(rèn)的 Logback 就可以了。

日志格式

Spring Boot的默認(rèn)日志輸出類似于以下示例:

2014-03-05 10:57:51.112  INFO 45469 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/7.0.52
2014-03-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2014-03-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1358 ms
2014-03-05 10:57:51.698  INFO 45469 --- [ost-startStop-1] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'dispatcherServlet' to [/]
2014-03-05 10:57:51.702  INFO 45469 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean  : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]

輸出如下元素:

  • 時(shí)間日期:精確到毫秒,容易排序
  • 日志級(jí)別:ERROR、WARN、INFO、DEBUGTRACE
  • 進(jìn)程ID
  • 分隔符:采用 --- 標(biāo)識(shí)日志開始部分
  • 線程名:方括號(hào)括起來(可能會(huì)截?cái)嗫刂婆_(tái)輸出)
  • Logger名:通常使用源代碼的類名
  • 日志內(nèi)容

Logback 是沒有 FATAL級(jí)別的日志,它將被映射到 ERROR

控制臺(tái)輸出

Spring Boot默認(rèn)的日志配置打印日志到控制臺(tái)。默認(rèn)情況下,ERROR、WARN以及INFO-級(jí)別的日志會(huì)被輸出??梢栽趩?dòng)應(yīng)用時(shí)加上--debug來啟用"debug"模式。

$ java -jar myapp.jar --debug

也可在 application.properties 配置 debug=true

顏色編碼

如果終端支持ANSI,則會(huì)使用彩色輸出來提高可讀性??梢栽O(shè)置 spring.output.ansi.enabled支持的值來覆蓋自動(dòng)檢測(cè)。
定義在Enum AnsiOutput.Enabled中

  • ALWAYS: 啟用 ANSI 彩色輸出
  • DETECT: 嘗試檢測(cè) ANSI 著色功能是否可用(默認(rèn))
  • NEVER: 禁用 ANSI 彩色輸出

日志級(jí)別與顏色對(duì)照表

Level Color
WARN Yellow
FATAL、ERROR Red
INFO、DEBUG、TRACE Green

如果想修改日志默認(rèn)色值,可以通過使用 %clr 關(guān)鍵字轉(zhuǎn)換。比如想使文本變?yōu)辄S色 %clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}。目前支持的顏色有(blue、cyan、faint、green、magenta、red、yellow)

文件輸出

默認(rèn)情況下,SpringBoot 僅將日志輸出到控制臺(tái),不會(huì)寫入到日志文件中去。如果除了控制臺(tái)輸出之外還想寫日志文件,則需要在application.properties設(shè)置logging.filelogging.path 屬性。

logging.file logging.path 示例 描述
(none) (none) 僅控制臺(tái)輸出日志
指定的文件 (none) my.log 輸出日志到指定文件Names can be an exact location or relative to the current directory.
(none) 指定的目錄 /var/log 將名為 spring.log 寫入到指定目錄中Names can be an exact location or relative to the current directory.

日志文件在達(dá)到 10MB 時(shí)進(jìn)行切割,產(chǎn)生一個(gè)新的日志文件(如:spring.1.logspring.2.log),新的日志依舊輸出到 spring.log 中去,默認(rèn)情況下會(huì)記錄 ERROR、WARN、INFO 級(jí)別日志。

logging.file.max-size: 限制日志文件大小
logging.file.max-history: 限制日志保留天數(shù)

日志級(jí)別

配置格式:logging.level.<logger-name>=<level>
如:

logging.level.root = WARN
logging.level.org.springframework.web = DEBUG
logging.level.org.hibernate = ERROR

#比如 mybatis sql日志
logging.level.org.mybatis = INFO
logging.level.mapper所在的包 = DEBUG

自定義日志配置

可以通過在類路徑中包含適當(dāng)?shù)膸?kù)來激活各種日志記錄系統(tǒng),并且可以通過在類路徑的根目錄中或通過logging.config指定配置文件位置。

由于日志服務(wù)一般都在ApplicationContext創(chuàng)建前就初始化了,它并不是必須通過Spring的配置文件控制。因此通過系統(tǒng)屬性和傳統(tǒng)的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

Logging System Customization
Logback logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy
Log4j2 log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging) logging.properties

Logback擴(kuò)展配置

該擴(kuò)展配置僅適用 logback-spring.xml 或者設(shè)置 logging.config 屬性的文件,因?yàn)?logback.xml 加載過早,因此無法獲取 SpringBoot 的一些擴(kuò)展屬性

使用擴(kuò)展屬性 springProfilespringProperty 讓你的 logback-spring.xml 配置顯得更有逼格,當(dāng)別人還在苦苦掙扎弄logback-{profile}.xml的時(shí)候 你一個(gè)文件就搞定了...

springProfile

<springProfile> 標(biāo)簽使我們讓配置文件更加靈活,它可以選擇性的包含或排除部分配置。

<springProfile name="dev">
    <!-- 開發(fā)環(huán)境時(shí)激活 -->
</springProfile>

<springProfile name="dev,test">
    <!-- 開發(fā),測(cè)試的時(shí)候激活-->
</springProfile>

<springProfile name="!prod">
    <!-- 當(dāng) "生產(chǎn)" 環(huán)境時(shí),該配置不激活-->
</springProfile>

案例

<!-- 開發(fā)環(huán)境日志級(jí)別為DEBUG/并且開發(fā)環(huán)境不寫日志文件 -->
<springProfile name="dev">
    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
    </root>
</springProfile>

<!-- 測(cè)試環(huán)境日志級(jí)別為INFO/并且記錄日志文件 -->
<springProfile name="test">
    <root level="INFO">
        <appender-ref ref="FILE"/>
        <appender-ref ref="STDOUT"/>
    </root>
</springProfile>

springProperty

<springProperty> 標(biāo)簽可以讓我們?cè)?Logback 中使用 Spring Environment 中的屬性。如果想在logback-spring.xml中回讀 application.properties 配置的值時(shí),這是一個(gè)非常好的解決方案

<!-- 讀取 spring.application.name 屬性來生成日志文件名
    scope:作用域
    name:在 logback-spring.xml 使用的鍵
    source:application.properties 文件中的鍵
    defaultValue:默認(rèn)值
 -->
<springProperty scope="context" name="logName" source="spring.application.name" defaultValue="myapp.log"/>

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/${logName}.log</file>
</appender>

Spring Boot默認(rèn)關(guān)于logback配置

Spring Boot默認(rèn)logback配置

base.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--
Base logback configuration provided for compatibility with Spring Boot 1.1
-->

<included>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</included>

defaults.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--
Default logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->

<included>
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    <property name="FILE_LOG_PATTERN" value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

    <logger name="org.apache.catalina.startup.DigesterFactory" level="ERROR"/>
    <logger name="org.apache.catalina.util.LifecycleBase" level="ERROR"/>
    <logger name="org.apache.coyote.http11.Http11NioProtocol" level="WARN"/>
    <logger name="org.apache.sshd.common.util.SecurityUtils" level="WARN"/>
    <logger name="org.apache.tomcat.util.net.NioSelectorPool" level="WARN"/>
    <logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="ERROR"/>
    <logger name="org.hibernate.validator.internal.util.Version" level="WARN"/>
</included>

console-appender.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--
Console appender logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->

<included>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
</included>

file-appender.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--
File appender logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->

<included>
    <appender name="FILE"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <file>${LOG_FILE}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
            <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
            <maxHistory>${LOG_FILE_MAX_HISTORY:-0}</maxHistory>
        </rollingPolicy>
    </appender>
</included>

自定義logback-spring.xml

以下是我自定義的logback配置,結(jié)合了Spring Boot對(duì)logback的擴(kuò)展springProfilespringProperty。當(dāng)設(shè)置spring.profiles.active=dev時(shí)日志級(jí)別為DEBUG,且只在控制臺(tái)輸出日志信息;當(dāng)設(shè)置spring.profiles.active=testprod時(shí)日志級(jí)別為INFO,會(huì)在控制臺(tái)和文件中輸出日志信息,且對(duì)INFO、ERROR、WARN級(jí)別的日志分別按天輸出到不同的文件中去,如INFO級(jí)別日志輸出文件名默認(rèn)info.log但當(dāng)文件大小達(dá)到10MB時(shí)會(huì)切分一次,產(chǎn)生新的日志文件eg: info-2018-07-01.0.log、info-2018-07-01.1.loginfo-2018-07-01.2.log...

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true">

    <contextName>RestAPI</contextName>

    <!-- 控制臺(tái)輸出日志格式 -->
    <!--%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger - %msg%n-->
    <property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:- } --- [%15.15t] %-40.40logger{39} : %m%n"/>
    <!-- 文件日志輸出格式 -->
    <property name="FILE_LOG_PATTERN" value="-%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:- } --- [%t] %-40.40logger{39} : %m%n"/>

    <logger name="org.apache.catalina.startup.DigesterFactory" level="ERROR"/>

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <property name="LOG_PATH" value="/Users/fulgens/log"/>
    <springProperty scope="context" name="appName" source="spring.application.name" defaultValue="myApp"/>

    <appender name="FILE_ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/${appName}/error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${appName}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <append>true</append>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!--<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>-->
    </appender>

    <appender name="FILE_WARN_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/${appName}/warn.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${appName}/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <append>true</append>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="FILE_INFO_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/${appName}/info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${appName}/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <append>true</append>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- MyBatis sql日志 -->
    <logger name="com.example.springbootlogging.mapper" level="DEBUG" additivity="false"></logger>

    <!-- 開發(fā)環(huán)境日志級(jí)別為DEBUG/并且開發(fā)環(huán)境不寫日志文件 -->
    <springProfile name="dev">
        <root level="DEBUG">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>

    <!-- 測(cè)試環(huán)境日志級(jí)別為INFO/并且記錄日志文件 -->
    <springProfile name="test">
        <root level="INFO">
            <appender-ref ref="FILE_ERROR_LOG"/>
            <appender-ref ref="FILE_WARN_LOG"/>
            <appender-ref ref="FILE_INFO_LOG"/>
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>

    <!-- 生產(chǎn)環(huán)境日志級(jí)別為INFO/并且記錄日志文件 -->
    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="FILE_ERROR_LOG"/>
            <appender-ref ref="FILE_WARN_LOG"/>
            <appender-ref ref="FILE_INFO_LOG"/>
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>

</configuration>

附Spring Boot所有Logging配置項(xiàng)

以下是我自定義的logback

# LOGGING 
logging.config= # Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback.
logging.exception-conversion-word=%wEx # Conversion word used when logging exceptions.
logging.file= # Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory.
logging.file.max-history=0 # Maximum of archive log files to keep. Only supported with the default logback setup.
logging.file.max-size=10MB # Maximum log file size. Only supported with the default logback setup.
logging.level.*= # Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`.
logging.path= # Location of the log file. For instance, `/var/log`.
logging.pattern.console= # Appender pattern for output to the console. Supported only with the default Logback setup.
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS # Appender pattern for log date format. Supported only with the default Logback setup.
logging.pattern.file= # Appender pattern for output to a file. Supported only with the default Logback setup.
logging.pattern.level=%5p # Appender pattern for log level. Supported only with the default Logback setup.
logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容