Logback SiftingAppender 使用

1、簡介

SiftingAppender 可根據給定的運行時屬性將日誌分離或篩選。例如，SiftingAppender 可以根據用戶會話將日誌事件分開，以便不同用戶生成的日誌進入不同的日誌文件，每個用戶一個日誌文件。SiftingAppender 有兩個屬性：

timeout SiftingAppender 會關閉並取消引用超時(連續多長時間未訪問)的 appender，預設的超時時間為30分鐘。
maxAppenderCount SiftingAppender 可能創建和跟蹤的嵌套 appender 的最大數量，預設值為 Integer.MAX_VALUE。

SiftingAppender 通過動態創建嵌套 appender 來實現日誌分離功能。嵌套 appender 是基於 SiftingAppender 本身配置中指定的模板創建的（包含在<sift>元素中）。 SiftingAppender 負責管理子 appender的生命周期。例如，SiftingAppender 將自動關閉和刪除任何超時的 appender。

處理日誌事件時，SiftingAppender 將選擇一個子 appender 進行委派。選擇標準由判別器在運行時計算。用戶可以藉助判別器指定選擇標準。

2、實際使用

假設有多個不同的任務通過多線程在同時運行，如果日誌列印到同一個文件中，不方便查看；這裡使用 SiftingAppender 來實現不同的任務日誌輸出到不同的日誌文件中，使用到的軟體版本：logback 1.2.12、Java 1.8.0_341

2.1、引入依賴

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.12</version>
</dependency>

2.2、新建日誌配置文件 logback.xml

<?xml version="1.0" encoding="utf-8"?>
<configuration debug="false">
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d %level [%thread] %logger[%L] -> %m%n</pattern>
        </encoder>
    </appender>

    <appender name="TASKOUT" class="ch.qos.logback.classic.sift.SiftingAppender">
        <Discriminator class="ch.qos.logback.classic.sift.MDCBasedDiscriminator">
            <key>taskFile</key>
            <DefaultValue>invalid</DefaultValue>
        </Discriminator>
        <sift>
            <appender name="FILE-${taskFile}" class="ch.qos.logback.core.FileAppender">
                <file>logs/${taskFile}</file>
                <encoder>
                    <pattern>
                        %d %level -> %m%n
                    </pattern>
                    <charset>UTF-8</charset>
                </encoder>
                <append>true</append>
            </appender>
        </sift>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>

    <logger name="task.log" level="info" additivity="false">
        <appender-ref ref="TASKOUT" />
    </logger>
</configuration>

Discriminator 主要用於選擇子 Appender，上面的配置定義使通過 taskFile 變數的值來選擇子 Appender。Discriminator 如果不指定 class 屬性，預設為：ch.qos.logback.classic.sift.MDCBasedDiscriminator，它需要兩個屬性：key、DefaultValue；key 是通過 MDC 設置的值，DefaultValue 是預設值。可以通過繼承 org.apache.dolphinscheduler.service.log.AbstractDiscriminator 來實現自己的 Discriminator。

2.3、Java 代碼

package com.inspur.demo.log;

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

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.CountDownLatch;

public class SiftingAppenderCase {
    public static final Logger logger = LoggerFactory.getLogger(SiftingAppenderCase.class);
    public static final Logger taskLogger = LoggerFactory.getLogger("task.log");

    public static void main(String[] args) throws InterruptedException {
        logger.info("應用啟動。。。");
        int num = 5;
        CountDownLatch countDownLatch = new CountDownLatch(num);
        for (int i = 1000; i < 1000 + num; i++) {
            String taskFile = i + ".log";
            new Thread(() -> {
                MDC.put("taskFile", taskFile);
                taskLogger.info("任務開始。。。");
                taskLogger.info("任務處理。。。");
                try {
                    Thread.sleep(1000);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                taskLogger.info("任務結束");
                MDC.remove("taskFile");
                countDownLatch.countDown();
            }).start();
        }
        countDownLatch.await();
        logger.info("應用結束。");
    }
}

 任務相關的日誌輸出到對應的日誌文件中，其他日誌輸出到控制台；運行程式後，在工程目錄下 logs 目錄下生成了不同的日誌文件：

參考：https://logback.qos.ch/manual/appenders.html。