Logback SiftingAppender 使用

2023-06-18 10:43 由且行且码发表于 #后端开发

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。