Java中的MarkerFilter的應用場景及使用示例詳解

更新時間：2024年01月29日 09:23:03 作者：滴水可藏海

這篇文章主要介紹了Java中的MarkerFilter的應用場景及使用示例詳解,使用log4j2,負責從消息隊列收集日志的,現在系統(tǒng)收集到的日志能和這個系統(tǒng)本身的日志分開,需要的朋友可以參考下

背景

有一個系統(tǒng)是負責從消息隊列收集日志的，現在系統(tǒng)收集到的日志能和這個系統(tǒng)本身的日志分開
使用log4j2

 <!--log4j2依賴-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
    <version>2.0.1.RELEASE</version>
</dependency>
<!-- Log4j2 異步支持 -->
<dependency>
    <groupId>com.lmax</groupId>
    <artifactId>disruptor</artifactId>
    <version>3.3.6</version>
</dependency>

解決方案

給我們需要的日志時間給一個特定的標記（Marker），然后使用MarkerFilter來區(qū)分收集的日志與系統(tǒng)本身的日志

代碼

log4j2.xml配置示例

<?xml version="1.0" encoding="UTF-8"?>
<!-- Configuration后面的status，這個用于設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時，
 你會看到log4j2內部各種詳細輸出?？梢栽O置成OFF(關閉)或Error(只輸出錯誤信息)
-->
<Configuration status="error" monitorInterval="60">
    <!-- 日志文件目錄和壓縮文件目錄配置 -->
    <Properties>
        <Property name="level">debug</Property>
        <Property name="fileName">./logs/test-program</Property>
        <Property name="fileGz">./logs/test-program</Property>
        <Property name="LOG_PATTERN">
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level - %logger{36}.%M[%L] - %msg%xEx%n
        </Property>
    </Properties>
 
    <Appenders>
        <!-- 輸出控制臺日志的配置 -->
        <Console name="console" target="SYSTEM_OUT">
            <!--控制臺只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
            <!-- 輸出日志的格式 -->
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </Console>
 
        <!-- 打印出所有的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮，作為存檔 -->
        <RollingRandomAccessFile name="appLogAppender" fileName="${fileName}/app.log" immediateFlush="false"
                                 filePattern="${fileGz}/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.gz">
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="6" modulate="true"/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <Filters>
            	<!--如果日志事件LogEvent中有COLLECTED標記，則直接拒絕這個日志事件-->
                <MarkerFilter marker="COLLECTED" onMatch="DENY" onMismatch="NEUTRAL"/>
                <!--如果日志事件LogEvent中的日志等級為${level}及以上，則接受這個日志事件-->
                <ThresholdFilter level="${level" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <!-- 指定每天的最大壓縮包個數，默認7個，超過了會覆蓋之前的 -->
            <DefaultRolloverStrategy max="10"/>
        </RollingRandomAccessFile>
 
        <!-- 打印出所有的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮，作為存檔 -->
        <RollingRandomAccessFile name="collectedLogAppender" fileName="${fileName}/collected.log" immediateFlush="false"
                                 filePattern="${fileGz}/$${date:yyyy-MM}/collected-%d{MM-dd-yyyy}-%i.gz">
            <PatternLayout pattern="%msg%xEx%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="6" modulate="true"/>
                <SizeBasedTriggeringPolicy size="500 MB"/>
            </Policies>
            <Filters>
                <!--如果日志事件LogEvent中有COLLECTED標記，則繼續(xù)走接下來的filter，如果接下來沒有其他的filter，onMatch的動作填ACCEPT就好了-->
                <MarkerFilter marker="COLLECTED" onMatch="NEUTRAL" onMismatch="DENY"/>
                <ThresholdFilter level="${level" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <!-- 指定每天的最大壓縮包個數，默認7個，超過了會覆蓋之前的 -->
           <DefaultRolloverStrategy max="1000"/>
        </RollingRandomAccessFile>
 
    </Appenders>
 
    <!-- 全局配置，默認所有的Logger都繼承此配置 -->
    <Loggers>
        <Root level="${level}" additivity="false" includeLocation="true">
            <AppenderRef ref="collectedLogAppender"/>
            <AppenderRef ref="appLogAppender"/>
            <AppenderRef ref="console"/>
        </Root>
    </Loggers>
</Configuration>

代碼示例

//需要引入lombok的依賴
import lombok.extern.slf4j.Slf4j;
//這里包名容易搞錯，需要特別注意
import org.slf4j.Marker;
import org.slf4j.MarkerFactory;
import org.slf4j.Marker;
 
@Slf4j
public class LogCollector {
    private static final Marker COLLECTED_MARKER = MarkerFactory.getMarker("test_marker");
 
    public static void main(String[] args) {
        log.info(COLLECTED_MARKER,  "Test message~");
   }
}