Exploring
unclezs
2020-12-03
0
目录

logback中的Appender

# 介绍

Appender最终负责输出日志记录事件。但是，他们可以将事件的实际格式委托给Layout或Encoder对象。每个布局/编码器都与一个且只有一个appender相关联。一些appender具有内置或固定的事件格式。因此，它们不需要布局/编码器。例如，SocketAppender可以简单地序列化日志记录事件，然后再通过网络传输它们

# AppenderBase

ch.qos.logback.core.AppenderBase类是实现Appender接口的抽象类。它提供了所有Appender共享的基本功能，例如获取或设置其名称的方法，其激活状态，其布局和其过滤器。它是Logback附带的所有附加程序的超类。尽管是抽象类，但AppenderBase实际上在Append接口中实现了doAppend（）方法。

可以看到这是一个同步方法，最终还是调用了实现类来进行append.

public synchronized void doAppend(E eventObject) {

  // prevent re-entry.
  if (guard) {
    return;
  }

  try {
    guard = true;

    if (!this.started) {
      if (statusRepeatCount++ < ALLOWED_REPEATS) {
        addStatus(new WarnStatus(
            "Attempted to append to non started appender [" + name + "].",this));
      }
      return;
    }

    if (getFilterChainDecision(eventObject) == FilterReply.DENY) {
      return;
    }
    
    // ok, we now invoke the derived class's implementation of append
    this.append(eventObject);

  } finally {
    guard = false;
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# OutputStreamAppender

负责基于Java中java.io.OutputStream实现的一个Appender，可以结合类图了解一下

参数：

# ConsoleAppender

参数：

  • encoder(Encoder (opens new window))：编码器
  • target(String)：System.out 或者 System.err，默认前者。
  • withJansi(boolean)：是否启用Jansi，这个会开启ANSI的颜色支持。windows需要下依赖org.fusesource.jansi:jansi:1.17 ，默认false。

# FileAppender

  • append(boolean)：追加模式，文件内容追加/覆盖，默认为true
  • encoder(Encoder (opens new window))：编码器
  • file(String)：文件全路径
  • prudent(boolean): 谨慎模式，开启后保证文件安全被写入，默认false

例子：

<configuration>
  <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>testFile.log</file>
    <append>true</append>
    <!--设置为false，吞吐量更高-->
    <immediateFlush>true</immediateFlush>
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>
        
  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# RollingFileAppender

这个是一个日志滚动记录器，也是是可以指定日志在什么情况下换一个日志文件进行存储，也是继承自FileAppnder.

参数：

  • fileName(String)
  • append(boolean)
  • encoder
  • rollingPolicy：在预警达到后做的操作
  • triggeringPolicy：控制在什么条件下出发
  • prudent: 谨慎模式，FixedWindowRollingPolicy不支持，TimeBasedRollingPolicy支持。

# rollingPolicies

  1. TimeBasedRollingPolicy

    • fileNamePattern(String)：文件名字的格式化，指定出发
    • maxHistory(int)，日志文件最多多少个
    • totalSizeCap(int)，所有日志文件可以用的最大空间，超过了会异步删除旧的，先判断maxHistory再判断totalSizeCap。
    • cleanHistoryOnStart(boolean)，启动的时候删除旧的文件
      <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>access-rolling-${today}.log</file>
    <append>true</append>
    <encoder>
        <pattern>${pattern}</pattern>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>%d{yyyy-MM-dd,aux}/%d{yyyy-MM-dd_HH-mm}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
        <totalSizeCap>3GB</totalSizeCap>
        <cleanHistoryOnStart>false</cleanHistoryOnStart>
    </rollingPolicy>
   </appender>
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13

  2. SizeAndTimeBasedRollingPolicy

    • maxFileSize 单个文件的最大大小。
    • 其他参数同TimeBasedRollingPolicy
      <appender name="ROLLING_FILE_SIZE_TIME" class="ch.qos.logback.core.rolling.RollingFileAppender">
          <file>access-rolling-${today}.log</file>
          <append>true</append>
          <encoder>
              <pattern>${pattern}</pattern>
          </encoder>
          <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
              <fileNamePattern>%d{yyyy-MM-dd,aux}/%d{yyyy-MM-dd_HH-mm}.log</fileNamePattern>
              <maxFileSize>100M</maxFileSize>
              <maxHistory>30</maxHistory>
              <totalSizeCap>3GB</totalSizeCap>
              <cleanHistoryOnStart>false</cleanHistoryOnStart>
          </rollingPolicy>
   </appender>
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14

  3. FixedWindowRollingPolicy

    • minIndex：初始,触发一次就会+1
    • maxIndex：最大，
    • fileNamePattern，文件名字，%i代表索引，%d代表时间
      <appender name="FILE_INDEX" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>test.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>tests.%i.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>1MB</maxFileSize>
        </triggeringPolicy>
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
  </appender>
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14

    第三个也看到了通过SizeBasedTriggeringPolicy达到了最大文件大小，触发索引的+1操作。到达最大值后进行归档。

# SiftingAppender

顾名思义，SiftingAppender可以根据给定的运行时属性来分离（或筛选）日志记录。例如，SiftingAppender可以根据用户会话将日志记录事件分开，以便将不同用户生成的日志放入不同的日志文件中，每个用户一个日志文件.

通过MDC传入userId

logger.debug("Application started");
MDC.put("userid", "Alice");
logger.debug("Alice says hello");
1
2
3
<configuration>

  <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">

    <discriminator>
      <key>userid</key>
      <defaultValue>unknown</defaultValue>
    </discriminator>
    <sift>
      <appender name="FILE-${userid}" class="ch.qos.logback.core.FileAppender">
        <file>${userid}.log</file>
        <append>false</append>
        <layout class="ch.qos.logback.classic.PatternLayout">
          <pattern>%d [%thread] %level %mdc %logger{35} - %msg%n</pattern>
        </layout>
      </appender>
    </sift>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="SIFT" />
  </root>
</configuration>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 自定义Appender

  • 编写Appender
package com.unclezs.samples.log.slf4j.logback.appender;

import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.AppenderBase;


public class MyAppender extends AppenderBase<ILoggingEvent> {

  static int MAX_COUNT = 10;
  int counter = 0;
  int limit = MAX_COUNT;

  PatternLayoutEncoder encoder;

  @Override
  public void start() {
    if (this.encoder == null) {
      addError("No encoder set for the appender named [" + name + "].");
      return;
    }
    super.start();
  }

  @Override
  public void append(ILoggingEvent event) {
    if (counter >= limit) {
      return;
    }
    //格式化
    String bytes = this.encoder.getLayout().doLayout(event);
    System.out.print(bytes);
    counter++;
  }

  /**
   * 通过getter setter设置
   */
  public PatternLayoutEncoder getEncoder() {
    return encoder;
  }

  public void setEncoder(PatternLayoutEncoder encoder) {
    this.encoder = encoder;
  }

  public void setLimit(int limit) {
    this.limit = limit;
  }

  public int getLimit() {
    return limit;
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
  • 配置
<appender name="MY_APPENDER" class="com.unclezs.samples.log.slf4j.logback.appender.MyAppender">
  <limit>2</limit>
  <encoder>
      <pattern>${highlightPattern}</pattern>
  </encoder>
</appender>
1
2
3
4
5
6
7
  • 测试
public class MyAppenderSample {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(MyAppenderSample.class);
    for (int i = 0; i < 20; i++) {
      logger.info("第{}次", i);
    }
  }
}
1
2
3
4
5
6
7
8

# 其他appender

  • SMTP
  • DB
  • Syslog
  • Socket

略，官网查看 Logback Appender (opens new window)

在 GitHub 编辑此页 (opens new window)
上次更新: 2024/02/25, 12:11:11
logback配置文件语法
logback配置中的Encoder

← logback配置中的Encoder→

Theme by Vdoing | Copyright © 2018-2024 unclezs