logback過(guò)濾部分日志輸出的操作

更新時(shí)間：2021年08月30日 10:16:42 作者：lizz666

這篇文章主要介紹了logback過(guò)濾部分日志輸出的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

logback過(guò)濾部分日志輸出

場(chǎng)景

使用監(jiān)控異常日志進(jìn)行告警時(shí)，部分異常日志可能只是不需要告警，但無(wú)法通過(guò)編碼去除時(shí)，可以通過(guò)不輸出這類異常日志達(dá)到忽略告警的目的。

比如在系統(tǒng)中經(jīng)常會(huì)出現(xiàn)斷開(kāi)的管道的相關(guān)問(wèn)題，異常如下

org.apache.catalina.connector.ClientAbortException: java.io.IOException: 斷開(kāi)的管道
org.apache.catalina.connector.ClientAbortException: java.io.IOException: broken pipe
[587ce8c8] Error [reactor.netty.ReactorNetty$InternalNettyException: java.nio.channels.ClosedChannelException] for HTTP GET "/xxxx", but ServerHttpResponse already committed (200 OK)

有因?yàn)槭褂每蚣艿脑虍惓o(wú)法捕獲，在不改源碼的情況下可以通過(guò)是用日志過(guò)濾的方式處理。

日志過(guò)濾

基于logback的基礎(chǔ)上引入jar包，不引入無(wú)法啟動(dòng)。

        <!--日志過(guò)濾-->
        <dependency>
            <groupId>org.codehaus.janino</groupId>
            <artifactId>commons-compiler</artifactId>
            <version>3.0.12</version>
        </dependency>
        <dependency>
            <groupId>org.codehaus.janino</groupId>
            <artifactId>janino</artifactId>
            <version>3.0.12</version>
        </dependency>

添加過(guò)濾條件

        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
             <!--增加日志匹配處理-->
            <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
                <!--匹配處理器-->
                <evaluator>
                    <!-- 處理模式，默認(rèn)為 ch.qos.logback.classic.boolex.JaninoEventEvaluator -->   
                    <!-- 存在某個(gè)字符串則匹配成功 -->   
                    <expression>return message.contains("broken pipe");</expression>
                    <!-- <expression>return message.contains("broken pipe")
                        || message.contains("斷開(kāi)的管道") ;</expression> -->  
                </evaluator>
                <!--匹配則停止執(zhí)行日志輸出-->
                <OnMatch>DENY</OnMatch>
                <!--不匹配則往下執(zhí)行-->
                <OnMismatch>ACCEPT</OnMismatch>
            </filter>
            <!--調(diào)用其他日志處理-->
            <appender-ref ref="KAFKA"/>
        </appender>

Logback 自定義靈活的日志過(guò)濾規(guī)則

當(dāng)我們需要對(duì)日志的打印要做一些范圍的控制的時(shí)候，通常都是通過(guò)為各個(gè)Appender設(shè)置不同的Filter配置來(lái)實(shí)現(xiàn)。在Logback中自帶了兩個(gè)過(guò)濾器實(shí)現(xiàn)：ch.qos.logback.classic.filter.LevelFilter和ch.qos.logback.classic.filter.ThresholdFilter，用戶可以根據(jù)需要來(lái)配置一些簡(jiǎn)單的過(guò)濾規(guī)則，下面先簡(jiǎn)單介紹一下這兩個(gè)原生的基礎(chǔ)過(guò)濾器。

ch.qos.logback.classic.filter.LevelFilter過(guò)濾器的作用是通過(guò)比較日志級(jí)別來(lái)控制日志輸出。

下面是一個(gè)只記錄日志級(jí)別為ERROR的例子

<appender name="ERROR_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/error.log</file>ds
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>ERROR</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{30} - %msg%n</pattern>
    </encoder>
</appender>

LevelFilter通過(guò)定義日志級(jí)別，并設(shè)置匹配與不匹配的處理策略來(lái)控制針對(duì)某個(gè)級(jí)別日志的輸出策略。

當(dāng)我們要設(shè)置多個(gè)不同級(jí)別的日志策略的時(shí)候，如果僅依靠這個(gè)過(guò)濾器，我們就要級(jí)聯(lián)的定義多個(gè)filter來(lái)控制才能實(shí)現(xiàn)，顯然不是很方便，所以此時(shí)我們就可以使用ch.qos.logback.classic.filter.ThresholdFilter過(guò)濾器來(lái)控制了。

比如下面的配置，實(shí)現(xiàn)了只記錄WARN及以上級(jí)別的控制，比WARN級(jí)別低（如：INFO、DEBUG、TRACE）都不會(huì)記錄。

<appender name="WARN_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/warn_error.log</file>
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>WARN</level>
    </filter>
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{30} - %msg%n</pattern>
    </encoder>
</appender>

通過(guò)上述介紹的兩個(gè)過(guò)濾器來(lái)控制日志的記錄級(jí)別已經(jīng)滿足絕大部分的需求，但是可能還是會(huì)出現(xiàn)一些特殊情況，需要自定義復(fù)雜的過(guò)濾規(guī)則，比如想過(guò)濾掉一些框架中的日志，通過(guò)自帶的幾個(gè)過(guò)濾器已經(jīng)無(wú)法完全控制，并且也不希望修改框架源碼來(lái)實(shí)現(xiàn)。這個(gè)時(shí)候，我們就可以自己來(lái)實(shí)現(xiàn)過(guò)濾器，并配置使用。實(shí)現(xiàn)的方式也很簡(jiǎn)單，只需要實(shí)現(xiàn)Logback提供的ch.qos.logback.core.filter.Filter接口即可。

下面舉一個(gè)簡(jiǎn)單的例子

public class MyFilter extends Filter<ILoggingEvent> {
    @Override
    public FilterReply decide(ILoggingEvent event) {
        if (event.getLevel() == Level.ERROR) {
            switch (event.getLoggerName()) {
                case "org.springframework.cloud.sleuth.instrument.web.ExceptionLoggingFilter":
                    return FilterReply.DENY;
            }
            return FilterReply.ACCEPT;
        }
        return FilterReply.DENY;
    }
}

上面過(guò)濾器的功能主要是通過(guò)重寫(xiě)decide，限制了org.springframework.cloud.sleuth.instrument.web.ExceptionLoggingFilter類輸出ERROR級(jí)別的日志記錄。在編寫(xiě)好自己的過(guò)濾器實(shí)現(xiàn)之后，只需要在Appender中配置使用就能實(shí)現(xiàn)自己需要的靈活過(guò)濾規(guī)則了：

<appender name="WARN_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/warn_error.log</file>
    <filter class="com.didispace.log.filter.ExceptionClassFilter"></filter>
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{30} - %msg%n</pattern>
    </encoder>
</appender>

更多關(guān)于Logback過(guò)濾器的內(nèi)容可參考官方文檔

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: