温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

log4j2如何使用filter过滤日志

发布时间:2021-12-24 11:33:44 来源:亿速云 阅读:950 作者:小新 栏目:开发技术

小编给大家分享一下log4j2如何使用filter过滤日志,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!

背景说明

log4j2作为log4j的升级版本,其性能自然是大大优于log4j的,同时其其性能又是优于logback的,甚至在部分领域,log4j2的性能远超logback几个数量级。   

log4j2的亮点主要在这几个方法进行体现:异步、并发、配置优化、插件机制等。本文初步学习基于log4j2插件机制的Filter。

Filter.Result的三种过滤结果

log4j2走过滤器的逻辑后,会返回对应的过滤Result结果,以控制是否记录日志、怎样记录日志。过滤器的结果有:

log4j2如何使用filter过滤日志

  • ACCEPT:(不需要再走后面的过滤器了,)需要记录当前日志。

  • NEUTRAL:需不需要记录当前日志,由后续过滤器决定。若所有过滤器返回的结果都是NEUTRAL,那么需要记录日志。

  • DENY:(不需要再走后面的过滤器了,)不需要记录当前日志。

提示:log4j2的此机制与logback是一样的。

log4j2提供的过滤器(功能简述)

提示: 下图基于log4j2.13.3。

log4j2如何使用filter过滤日志

过滤器说明是否常用
StringMatchFilter如果格式化后(即:最终)的日志信息中包含${指定的字符串},则onMatch,否则onMismatch 即: msg.contains(this.text) ? onMatch : onMismatch;
LevelRangeFilter若${maxLevel} <= 日志级别 <= ${minLevel}, 则onMatch,否则onMismatch 如: 即为只记录日志info及warn级别的日志。
RegexFilter如果日志信息匹配${指定的正则表达式},则onMatch,否则onMismatch 注:可通过useRawMsg属性来控制这个日志信息是格式化处理后(即:最终)的日志信息,还是格式化处理前(即:代码中输入)的日志信息。
ThresholdFilter若日志级别 >= ${指定的日志级别}, 则onMatch,否则onMismatch
LevelMatchFilter如果日志级别等于${指定的日志级别},则onMatch,否则onMismatch
ThreadContextMapFilter通过context(可以理解为一个Map)中对应的key-value值进行过滤 注:上下文默认是ThreadContext,也可以自定义使用ContextDataInjectorFactory配置ContextDataInjector来指定。
DynamicThresholdFilter若上下文中包含指定的key,则触发DynamicThresholdFilter生效;若该key对应的value值等于任意一个我们指定的值,那么针对本条日志,可记录日志级别的约束下限调整为指定的级别 注:上下文默认是ThreadContext,也可以自定义使用ContextDataInjectorFactory配置ContextDataInjector来指定。 示例说明:<DynamicThresholdFilter key="loginRole" defaultThreshold="ERROR" onMatch="ACCEPT" onMismatch="NEUTRAL"><KeyValuePair key="admin" value="DEBUG"/><KeyValuePair key="user" value="warn"/></DynamicThresholdFilter>配置,有以下情况: 情况一:存在键loginRole,假设从上下文(可以理解为一个Map)中取出来的对应的值为user,那么此时,对于日志级别大于等于warn的日志,会走onMatch;其它的日志级别走onMismatch。 情况二:存在键loginRole,假设从context(可以理解为一个Map)中取出来的对应的值为admin,那么此时,对于日志级别大于等于debug的日志,会走onMatch;其它的日志级别走onMismatch。 情况三:【上下文(可以理解为一个Map)中,不存在键loginRole】或【存在键loginRole,但从日志上下文中取出来的值(假设)为abc, 没有对应的KeyValuePair配置】,那么此时<DynamicThresholdFilter key="userRole" defaultThreshold="AAA" onMatch="BBB" onMismatch="CCC">等价于<LevelMatchFilter level="AAA" onMatch="BBB" onMismatch="CCC">。
CompositeFilter组合过滤器,即:按照xml配置中的配置,一个过滤器一个过滤器的走,如果在这过程中,任意一个过滤器ACCEPT或DENY了,那么就不会往后走了,直接返回对应的结果。
TimeFilter如果记录日志时的当前时间落在每天指定的时间范围[start, end]内,则onMatch,否则onMismatch 如:<TimeFilter start="05:00:00" end="05:30:00" onMatch="ACCEPT" onMismatch="DENY"/>。
ScriptFilter是否匹配取决于指定的脚本返回值是否为true
DenyAllFilterThis filter causes all logging events to be dropped
BurstFilter对低于或等于${指定日志级别}的日志,进行限流控制
NoMarkerFilter如果从对应事件对象获取(LogEvent#getMarker)到的marker为null, 则onMatch,否则onMismatch
MarkerFilter如果从对应事件对象获取(LogEvent#getMarker)到的marker的name值为等于${指定的值}, 则onMatch,否则onMismatch
MapFilterThe MapFilter allows filtering against data elements that are in a MapMessage. 注:需要使用org.apache.logging.log4j.Logger进行记录,且记录org.apache.logging.log4j.message.MapMessage日志,才会生效。 注:因为暂时不兼容Slf4j这里不多作说明
StructuredDataFilterThe StructuredDataFilter is a MapFilter that also allows filtering on the event id, type and message. 注:需要使用org.apache.logging.log4j.Logger进行记录,且记录org.apache.logging.log4j.core.filter.StructuredDataFilter日志,才会生效。 注:因为暂时不兼容Slf4j这里不多作说明

Filter的作用范围

log4j2在处理日志时,各个Filter会组成过滤链,越靠前的Filter越先过滤,自然影响范围就越大。在log4j2的xml配置文件中,Filter可以配置在四个位置,由全局到局部依次是 Context-wide、 Logger和Appender、AppenderReference, 图示说明:

log4j2如何使用filter过滤日志

常用过滤器使用示例(文字版代码见文末链接)

StringMatchFilter

log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

LevelRangeFilter

log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

RegexFilter

log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

ThresholdFilter

log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

LevelMatchFilter

log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

ThreadContextMapFilter

示例一: log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

示例二: log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

DynamicThresholdFilter

log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

CompositeFilter

log4j2.xml配置

log4j2如何使用filter过滤日志

测试代码与输出日志

log4j2如何使用filter过滤日志

以上是“log4j2如何使用filter过滤日志”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注亿速云行业资讯频道!

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI