Logback SiftingAppender 使用

1、简介

SiftingAppender 可根据给定的运行时属性将日志分离或筛选。例如，SiftingAppender 可以根据用户会话将日志事件分开，以便不同用户生成的日志进入不同的日志文件，每个用户一个日志文件。SiftingAppender 有两个属性：
timeout SiftingAppender 会关闭并取消引用超时(连续多长时间未访问)的 appender，默认的超时时间为30分钟。
maxAppenderCount  SiftingAppender 可能创建和跟踪的嵌套 appender 的最大数量，默认值为 Integer.MAX_VALUE。
SiftingAppender 通过动态创建嵌套 appender 来实现日志分离功能。嵌套 appender 是基于 SiftingAppender 本身配置中指定的模板创建的（包含在元素中）。 SiftingAppender 负责管理子 appender的生命周期。例如，SiftingAppender 将自动关闭和删除任何超时的 appender。
处理日志事件时，SiftingAppender 将选择一个子 appender 进行委派。选择标准由判别器在运行时计算。用户可以借助判别器指定选择标准。
2、实际使用

假设有多个不同的任务通过多线程在同时运行，如果日志打印到同一个文件中，不方便查看；这里使用 SiftingAppender 来实现不同的任务日志输出到不同的日志文件中，使用到的软件版本：logback 1.2.12、Java 1.8.0_341
2.1、引入依赖

1. <dependency>
2.     <groupId>ch.qos.logback</groupId>
3.     <artifactId>logback-classic</artifactId>
4.     <version>1.2.12</version>
5. </dependency>

复制代码

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

1. <?xml version="1.0" encoding="utf-8"?>
2. <configuration debug="false">
3.     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
4.         <encoder>
5.             <pattern>%d %level [%thread] %logger[%L] -> %m%n</pattern>
6.         </encoder>
7.     </appender>
9.     <appender name="TASKOUT" class="ch.qos.logback.classic.sift.SiftingAppender">
10.         <Discriminator class="ch.qos.logback.classic.sift.MDCBasedDiscriminator">
11.             <key>taskFile</key>
12.             <DefaultValue>invalid</DefaultValue>
13.         </Discriminator>
14.         <sift>
15.             <appender name="FILE-${taskFile}" class="ch.qos.logback.core.FileAppender">
16.                 <file>logs/${taskFile}</file>
17.                 <encoder>
18.                     <pattern>
19.                         %d %level -> %m%n
20.                     </pattern>
21.                     <charset>UTF-8</charset>
22.                 </encoder>
23.                 <append>true</append>
24.             </appender>
25.         </sift>
26.     </appender>
28.     <root level="info">
29.         <appender-ref ref="STDOUT" />
30.     </root>
32.     <logger name="task.log" level="info" additivity="false">
33.         <appender-ref ref="TASKOUT" />
34.     </logger>
35. </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 代码

1. package com.inspur.demo.log;
3. import org.slf4j.Logger;
4. import org.slf4j.LoggerFactory;
5. import org.slf4j.MDC;
7. import java.text.SimpleDateFormat;
8. import java.util.Date;
9. import java.util.concurrent.CountDownLatch;
11. public class SiftingAppenderCase {
12.     public static final Logger logger = LoggerFactory.getLogger(SiftingAppenderCase.class);
13.     public static final Logger taskLogger = LoggerFactory.getLogger("task.log");
15.     public static void main(String[] args) throws InterruptedException {
16.         logger.info("应用启动。。。");
17.         int num = 5;
18.         CountDownLatch countDownLatch = new CountDownLatch(num);
19.         for (int i = 1000; i < 1000 + num; i++) {
20.             String taskFile = i + ".log";
21.             new Thread(() -> {
22.                 MDC.put("taskFile", taskFile);
23.                 taskLogger.info("任务开始。。。");
24.                 taskLogger.info("任务处理。。。");
25.                 try {
26.                     Thread.sleep(1000);
27.                 } catch (InterruptedException e) {
28.                     e.printStackTrace();
29.                 }
30.                 taskLogger.info("任务结束");
31.                 MDC.remove("taskFile");
32.                 countDownLatch.countDown();
33.             }).start();
34.         }
35.         countDownLatch.await();
36.         logger.info("应用结束。");
37.     }
38. }

复制代码

 任务相关的日志输出到对应的日志文件中，其他日志输出到控制台；运行程序后，在工程目录下 logs 目录下生成了不同的日志文件：

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

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！