完整示例

首先展示一個完整的示例以供參考。

<?xml version="1.0" encoding="UTF-8"?>
<configuration  scan="true" scanPeriod="10 seconds" debug="false">

    <contextName>logback</contextName>

    <timestamp key="ts" datePattern="yyyyMMdd'T'HHmmss"/>
    <property name="log.path" value="F:/logs/logback" />
    <property name="log.bak.path" value="F:/logs/logback/bak" />
    <property name="charset" value="UTF-8" />
    <property name="log.pattern.one" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>
    <property name="log.pattern.two" value="[${ts}] [%5level] %logger{0} - %msg%n"/>

    <!--輸出到控制檯-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <Pattern>${log.pattern.two}</Pattern>
            <charset>${charset}</charset>
        </encoder>
    </appender>

    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/context-info.log</file>
        <append>true</append>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <Pattern>${log.pattern.one}</Pattern>
            <charset>${charset}</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.bak.path}/info/context-info-%d{yyyyMMddHHmm}-%i.zip</fileNamePattern>
            <maxHistory>10</maxHistory>
            <maxFileSize>1KB</maxFileSize>
            <totalSizeCap>1MB</totalSizeCap>
        </rollingPolicy>
    </appender>


    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/warn.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${log.bak.path}/warn/warn-%i.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>5</maxIndex>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>1KB</maxFileSize>
        </triggeringPolicy>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <Pattern>${log.pattern.one}</Pattern>
            <charset>${charset}</charset>
        </encoder>
    </appender>

    <appender name="ERROR" class="ch.qos.logback.core.FileAppender">
        <file>${log.path}/error.log</file>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <Pattern>${log.pattern.one}</Pattern>
            <charset>${charset}</charset>
        </encoder>
    </appender>

<!--    <logger name="org.springframework.web" level="info"/>-->
<!--    <logger name="org.curitis.test" level="info" addtivity="true">-->
<!--        <appender-ref ref="INFO"/>-->
<!--    </logger>-->

    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="INFO" />
        <appender-ref ref="WARN" />
        <appender-ref ref="ERROR" />
    </root>

</configuration>
 

測試程式碼：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogTest {

    private static final Logger logger = LoggerFactory.getLogger(LogTest.class);

    public static void main(String[] args) {
        while (true) {
            logger.info("info");
            logger.warn("warn");
            logger.error("error");
        }
    }
}
 

日誌級別

日誌級別從低到高分為：

1. TRACE
2. DEBUG
3. INFO
4. WARN
5. ERROR
6. FATAL

configuration

scan:當此屬性設定為true時，配置檔案如果發生改變，將會被重新載入，預設值為true

scanPeriod:設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。當scan為true時，此屬性生效。預設的時間間隔為1分鐘。

debug:當此屬性設定為true時，將打印出logback內部日誌資訊，實時檢視logback執行狀態。預設值為false。

property

配置屬性，以便於在其他配置使用，一些公用的配置例如，日誌輸出格式，日誌檔案路徑等就可以配置為property。

<timestamp key="ts" datePattern="yyyyMMdd'T'HHmmss"/>
<property name="log.path" value="F:/logs/logback/" />
<property name="log.bak.path" value="F:/logs/bak/" />
<property name="charset" value="UTF-8" />
<property name="log.pattern.one" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>
<property name="log.pattern.two" value="[${ts}] [%5level] %logger{0} - %msg%n"/>

appender

我願意吧appender翻譯為輸出器，appender主要有3中：

1. ConsoleAppender
2. RollingFileAppender
3. FileAppender

ConsoleAppender是輸出到控制檯，RollingFileAppender是滾動日誌輸出器，一般用於輸出需要儲存一段時間的日誌，FileAppender一般是資料量比較小特別關注的日誌輸出器。

encoder

每一個appender都需要一個encoder，主要用於指定輸出日誌格式和編碼。

<encoder>
    <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</Pattern>
    <charset>UTF-8</charset>
</encoder>

過濾器(filter)

Appender可以配置多個過濾器，過濾器主要有3中：

1. ThresholdFilter
2. LevelFilter
3. EvaluatorFilter

ThresholdFilter

臨界值過濾器，Threshold是閾值，臨界值的意思，表示過濾掉低於指定臨界值的日誌。

當日志級別等於或高於臨界值時，過濾器返回NEUTRAL，當日志級別低於臨界值時，日誌會被拒絕。

例如，過濾掉所有低於INFO級別的日誌:

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">   
    <level>INFO</level>   
</filter>   

過濾器，執行一個過濾器會有返回個列舉值，即DENY，NEUTRAL，ACCEPT其中之一。返回DENY，日誌將立即被拋棄不再經過其他過濾器；返回NEUTRAL，有序列表裡的下個過濾器過接著處理日誌；返回ACCEPT，日誌會被立即處理，不再經過剩餘過濾器。

過濾器被新增到<Appender> 中，為<Appender> 新增一個或多個過濾器後，可以用任意條件對日誌進行過濾。<Appender> 有多個過濾器時，按照配置順序執行。

LevelFilter

級別過濾器，level是級別的意思，會根據日誌級別進行過濾。

如果日誌級別等於配置級別，過濾器會根據onMath和onMismatch的配置接收或拒絕日誌，onMath和onMismatch可以配置下面3個值：

1. DENY：日誌將立即被拋棄不再經過其他過濾器
2. NEUTRAL：下個過濾器過接著處理日誌
3. ACCEPT：日誌會被立即處理，不再經過剩餘過濾器

<filter class="ch.qos.logback.classic.filter.LevelFilter">
    <level>WARN</level>
    <onMatch>ACCEPT</onMatch>
    <onMismatch>DENY</onMismatch>
</filter>

通過LevelFilter可以將指定級別的日誌輸出到指定檔案。

EvaluatorFilter

表示式過濾器，評估、鑑別日誌是否符合指定條件。需要額外的兩個jar包：

1. commons-compiler.jar
2. janino.jar

表示式過濾器很強大，但是很少用，它可以根據event、message、hrowable、logger、level、loggerContext、marker等過濾。

<filter class="ch.qos.logback.core.filter.EvaluatorFilter">
  <evaluator>
    <expression>return message.contains("connection fail");</expression>
  </evaluator>
  <OnMatch>ACCEPT</OnMatch>
  <OnMismatch>DENY</OnMismatch>
</filter>

上面的示例是隻接收日誌中包含connection fail的日誌，還可以根據throwable過濾出指定異常的的日誌資訊，輸出到指定檔案，但是一般沒有必要。

Policy

Policy主要有3個：

1. SizeBasedTriggeringPolicy
2. FixedWindowRollingPolicy
3. SizeBasedTriggeringPolicy

FixedWindowRollingPolicy一般和SizeBasedTriggeringPolicy組合使用。

SizeAndTimeBasedRollingPolicy

<appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/context-info.log</file>
        <append>true</append>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <Pattern>${log.pattern.one}</Pattern>
            <charset>${charset}</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.bak.path}/info/context-info-%d{yyyyMMddHHmm}-%i.zip</fileNamePattern>
            <maxHistory>10</maxHistory>
            <maxFileSize>1KB</maxFileSize>
            <totalSizeCap>1MB</totalSizeCap>
        </rollingPolicy>
    </appender>

SizeAndTimeBasedRollingPolicy需要注意的地方是fileNamePattern的配置。 既然是時間和大小，那麼就要設定時間的策略，時間策略就是根據fileNamePattern的%d{yyyyMMddHHmm}部分來的。 %d{yyyyMMddHHmm}就是每分鐘滾動一次，生成一個新的檔案 %d{yyyyMMddHH}就是每一小時滾動一次，生成一個新的檔案 %d{yyyyMMdd}就是每天滾動一次，生成一個新的檔案

%i部分是指定大小的，因為不知道日誌有多少，所以是%i，實際上根據maxFileSize來生成，一個檔案大小達到maxFileSize就生成一個新檔案。

例如上面的配置就是${log.path}/context-info.log檔案一分鐘內就會至少會生成一個檔案，${log.bak.path}/info/context-info-201909281200-0.zip。

如果一分鐘之內context-info.log超過1kb就會生成多個。

上面的maxFileSize是為了測試設定很小，實際可以設定大一些，例如，如果日誌要存入hdfs就可以把maxFileSize設定為128M，這樣剛好是一個hdfs的block。

FixedWindowRollingPolicy與SizeBasedTriggeringPolicy

<appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.path}/warn.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
        <fileNamePattern>${log.bak.path}/warn/warn-%i.zip</fileNamePattern>
        <minIndex>1</minIndex>
        <maxIndex>5</maxIndex>
    </rollingPolicy>
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
        <maxFileSize>1KB</maxFileSize>
    </triggeringPolicy>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>WARN</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>
        <Pattern>${log.pattern.one}</Pattern>
        <charset>${charset}</charset>
    </encoder>
</appender>

固定視窗策略，最重要的配置是maxIndex，就是最大下標。結合SizeBasedTriggeringPolicy，達到指定檔案大小就會生成一個新的壓縮檔案。

例如，上面的配置就會最多生成5個壓縮檔案，每當warn.log達到1kb的時候就會生成一個warn-i.zip的壓縮檔案。

壓縮檔案最多5個，會迴圈覆蓋。

logger

給指定的包或者類配置日誌輸出

<logger name="org.springframework.web" level="info"/>
<logger name="org.curitis.test" level="info" addtivity="false">
    <appender-ref ref="INFO"/>
</logger>

logger預設使用的日誌輸出地方是控制檯，可以通過appender-ref修改。level指定輸出級別，addtivity設定為false表示，不在其他日誌輸出器中輸出了。

root

配置日誌輸出器

<root level="info">
    <appender-ref ref="CONSOLE" />
    <appender-ref ref="INFO" />
    <appender-ref ref="WARN" />
    <appender-ref ref="ERROR" />
</root>

level指定公共預設最低輸出級別，例如如果設定為WARN，則低於WARN的資訊都不會輸出

其他

包含其他配置檔案，可以是一些固定的配置，例如指定庫的日誌輸出配置檔案。

<include resource="classpath:logback-base.xml" />

指定環境環境：

<springProfile name="dev">
    <logger name="org.springframework" level="WARN"/>
</springProfile>

彩色日誌： org.springframework.boot.logging.logback.ColorConverter org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter

相關推薦