logback logback.xml常用配置詳解（三）

轉自：logback logback.xml常用配置詳解（三） <filter>

 

 

logback 常用配置詳解（三） <filter>

 

<filter>:

過濾器，執行一個過濾器會有返回個枚舉值，即DENY，NEUTRAL，ACCEPT其中之一。返回DENY，日志將立即被拋棄不再經過其他過濾器；返回NEUTRAL，有序列表里的下個過濾器過接着處理日志；返回ACCEPT，日志會被立即處理，不再經過剩余過濾器。

過濾器被添加到<Appender> 中，為<Appender> 添加一個或多個過濾器后，可以用任意條件對日志進行過濾。<Appender> 有多個過濾器時，按照配置順序執行。

 

下面是幾個常用的過濾器：

 

LevelFilter： 級別過濾器，根據日志級別進行過濾。如果日志級別等於配置級別，過濾器會根據onMath 和 onMismatch接收或拒絕日志。有以下子節點：

<level>:設置過濾級別

<onMatch>:用於配置符合過濾條件的操作

<onMismatch>:用於配置不符合過濾條件的操作

 

例如：將過濾器的日志級別配置為INFO，所有INFO級別的日志交給appender處理，非INFO級別的日志，被過濾掉。

<configuration>
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>INFO</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>
      <pattern>
        %-4relative [%thread] %-5level %logger{30} - %msg%n
      </pattern>
    </encoder>
  </appender>
  <root level="DEBUG">
    <appender-ref ref="CONSOLE" />
  </root>
</configuration>

 

ThresholdFilter： 臨界值過濾器，過濾掉低於指定臨界值的日志。當日志級別等於或高於臨界值時，過濾器返回NEUTRAL；當日志級別低於臨界值時，日志會被拒絕。

例如：過濾掉所有低於INFO級別的日志。

<configuration>
  <appender name="CONSOLE"
    class="ch.qos.logback.core.ConsoleAppender">
    <!-- 過濾掉 TRACE 和 DEBUG 級別的日志-->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>INFO</level>
    </filter>
    <encoder>
      <pattern>
        %-4relative [%thread] %-5level %logger{30} - %msg%n
      </pattern>
    </encoder>
  </appender>
  <root level="DEBUG">
    <appender-ref ref="CONSOLE" />
  </root>
</configuration>

 

EvaluatorFilter： 求值過濾器，評估、鑒別日志是否符合指定條件。有一下子節點：

<evaluator>:

鑒別器，常用的鑒別器是JaninoEventEvaluato，也是默認的鑒別器，它以任意的java布爾值表達式作為求值條件，求值條件在配置文件解釋過成功被動態編譯，布爾值表達式返回true就表示符合過濾條件。evaluator有個子標簽<expression>，用於配置求值條件。

 

求值表達式作用於當前日志，logback向求值表達式暴露日志的各種字段：

Name	Type	Description
event	LoggingEvent	與記錄請求相關聯的原始記錄事件，下面所有變量都來自event，例如，event.getMessage()返回下面"message"相同的字符串
message	String	日志的原始消息，例如，設有logger mylogger，"name"的值是"AUB"，對於 mylogger.info("Hello {}",name); "Hello {}"就是原始消息。
formatedMessage	String	日志被各式話的消息，例如，設有logger mylogger，"name"的值是"AUB"，對於 mylogger.info("Hello {}",name); "Hello Aub"就是格式化后的消息。
logger	String	logger 名。
loggerContext	LoggerContextVO	日志所屬的logger上下文。
level	int	級別對應的整數值，所以 level > INFO 是正確的表達式。
timeStamp	long	創建日志的時間戳。
marker	Marker	與日志請求相關聯的Marker對象，注意“Marker”有可能為null，所以你要確保它不能是null。
mdc	Map	包含創建日志期間的MDC所有值得map。訪問方法是：mdc.get("myKey") 。mdc.get()返回的是Object不是String，要想調用String的方法就要強轉，例如， ((String) mdc.get("k")).contains("val") .MDC可能為null，調用時注意。
throwable	java.lang.Throwable	如果沒有異常與日志關聯"throwable" 變量為 null. 不幸的是， "throwable" 不能被序列化。在遠程系統上永遠為null，對於與位置無關的表達式請使用下面的變量throwableProxy
throwableProxy	IThrowableProxy	與日志事件關聯的異常代理。如果沒有異常與日志事件關聯，則變量"throwableProxy" 為 null. 當異常被關聯到日志事件時，"throwableProxy" 在遠程系統上不會為null

 

 

<onMatch>:用於配置符合過濾條件的操作

<onMismatch>:用於配置不符合過濾條件的操作

 

例如：過濾掉所有日志消息中不包含“billing”字符串的日志。

<configuration>

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
      <evaluator> <!-- 默認為 ch.qos.logback.classic.boolex.JaninoEventEvaluator -->
        <expression>return message.contains("billing");</expression>
      </evaluator>
      <OnMatch>ACCEPT </OnMatch>
      <OnMismatch>DENY</OnMismatch>
    </filter>
    <encoder>
      <pattern>
        %-4relative [%thread] %-5level %logger - %msg%n
      </pattern>
    </encoder>
  </appender>

  <root level="INFO">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

 

<matcher> ：

匹配器，盡管可以使用String類的matches()方法進行模式匹配，但會導致每次調用過濾器時都會創建一個新的Pattern對象，為了消除這種開銷，可以預定義一個或多個matcher對象，定以后就可以在求值表達式中重復引用。<matcher>是<evaluator>的子標簽。

<matcher>中包含兩個子標簽，一個是<name>，用於定義matcher的名字，求值表達式中使用這個名字來引用matcher；另一個是<regex>，用於配置匹配條件。

 

例如：

<configuration debug="true">

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
      <evaluator>
        <matcher>
          <Name>odd</Name>
          <!-- filter out odd numbered statements -->
          <regex>statement [13579]</regex>
        </matcher>

        <expression>odd.matches(formattedMessage)</expression>
      </evaluator>
      <OnMismatch>NEUTRAL</OnMismatch>
      <OnMatch>DENY</OnMatch>
    </filter>
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger - %msg%n</pattern>
    </encoder>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

 

其他Filter不太常用我這里就不講了，大家可以參見官網。