How to Use the Log4Net StringMatchFilter

How to Use the Log4Net StringMatchFilter

Log4Net is a very powerful, easy to use logging tool, so it’s no surprise that so many .NET developers use it in their applications. One under documented (at least in my opinion) feature of it, is the use of filters to be more specific about what you want your appenders to filter out.

Recently, in an application I was working on, we wanted to only log specific messages that had certain strings present. The StringMatchFilter can do exactly this. Here is a sample configuration, using that filter:

<filter type="log4net.Filter.StringMatchFilter">
 <stringToMatch value="some string we want to match" />
 </filter>
 <filter type="log4net.Filter.StringMatchFilter">
 <stringToMatch value="another string that we could match" />
 </filter>
 <filter type="log4net.Filter.StringMatchFilter">
 <stringToMatch value="one last string to match" />
 </filter>
 <filter type="log4net.Filter.DenyAllFilter" />

This filter, goes inside the configuration for whatever Log4Net appender you’re using. There are some things to note here that could possibly trip you up:

  1. Filters are automatically evaluated as “OR”. From everything I’ve read, and understand, if you want to evaluate multiple filters in an “AND” fashion, you would need to write custom filters to accomplish this. This is not the default Log4Net behavior.
  2. In this case the DenyAllFilter tells Log4Net that if none of the strings are matched, we don’t log anything. The default behavior is to log everything that makes it through the OR conditions.
  3. Filters are evaluated in order, and thus, this is why the DenyAllFilter goes at the bottom. If a log message makes it that far without a match, we don’t watch to log it. In this case at least…
  4. The StringMatchFilter will match on partial strings, but is case-sensitive.

There are multiple other filters that Log4Net provides by default, that may come in handy, such as a level-range filter. Hopefully this blog post gives you a little more information on how Log4Net is actually evaluating these filters.

By | 2015-06-22T21:30:12+00:00 June 22nd, 2015|Categories: C#, Handy Tools/Utilities, Misc. Fixes|0 Comments

About the Author:

Leave A Comment