如何在log4net的stringToMatch过滤器中匹配带有换行符的消息?

10

我在配置一个StringMatchFilter时遇到了麻烦,它无法匹配带有换行符的消息字符串。我想要跳过一些消息,并添加了以下过滤器使其生效。

<filter type="log4net.Filter.StringMatchFilter">
  <param name="AcceptOnMatch" value="false" />
  <stringToMatch value="Unexpected exception in SocketThreadWorker" />
</filter>

但是如果我将stringToMatch更改为“远程主机强制关闭了现有连接”(出现在消息的第二行),过滤器就无法工作。这是因为消息中有换行符还是我的操作有误?

典型的消息可能如下所示:

------ 示例消息 ----------------------------

2011-05-04 16:22:24,078 [Client (connected from "127.0.0.1:4076" at 16:22)] ERROR - Unexpected exception in SocketThreadWorker System.Net.Sockets.SocketException:
An existing connection was forcibly closed by the remote host at System.Net.Sockets.Socket.EndReceive(IAsyncResult asyncResult)

------ 示例信息结束 ---------------------------

"SocketThreadWorker 中出现意外异常" 位于消息的第一行,“现有的连接被强制关闭” 位于第二行。

编辑

这个 appender 看起来像这样:

<appender name="SmtpAppender" type="log4net.Appender.SmtpAppender">
  <filter type="log4net.Filter.StringMatchFilter">
    <param name="AcceptOnMatch" value="false" /> 
    <stringToMatch value="An existing connection was forcibly closed by the remote host" />        
  </filter>
  <to value="..." />
  <from value="..." />
  <subject value="[... ${COMPUTERNAME}] An Error occurred" />
  <smtpHost value=".." />
  <bufferSize value="1024" />
  <lossy value="true" />
  <evaluator type="log4net.Core.LevelEvaluator">
     <threshold value="ERROR"/>
  </evaluator>
  <layout type="log4net.Layout.PatternLayout">
     <conversionPattern value="%newline%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
  </layout>
</appender>

这个错误消息并不是非常严重,我也不想通知任何人。该消息不是由我的代码产生的,而是来自我使用的一个库。


你能否请提供你的log4net配置部分? - Anthony Mastrean
根据我的回答,如果能提供生成此日志语句的代码会很好。 - Anthony Mastrean
另外,因为我认为这个问题不是“可修复的”,你能否发布一下你想要实现的目标(一般性地,而不是关于log4net),这样我们可以考虑替代方案? - Anthony Mastrean
丹尼尔,你能回来并接受一个答案吗? - Anthony Mastrean
1个回答

15

log4net追加方式的解释

SocketThreadWorker抛出了SocketException。异常信息为“远程主机强制关闭了一个现有的连接”,由错误代码映射。

throw new SocketException(10054);

产生日志记录的代码看起来像一个未处理的异常处理程序(由打印的消息“Unexpected exception...”表示)。但是,对于本答案,想象它看起来像这样

try
{
    ...
}
catch (Exception e)
{
    _log.Error("Unexpected exception in SocketThreadWorker", e);
}

在后台,log4net生成的是一个LoggingEvent。它包含提供的日志消息和异常对象(分别)。每个appender可以决定如何将这两个项目写入它们的最终目的地(以及其他属性、布局参数等)。 StringToMatch过滤器仅适用于日志消息。不适用于异常消息!查看下面的代码,我们将构建一个系统和一个测试来帮助我们调试问题。
复制和深度挖掘
这是一个简单的socket异常抛出类。
public class SocketThreadWorker
{
    public void DoWork()
    {
        throw new SocketException(10054);
    }
}

我们将配置log4net使用一个ConsoleAppender,并使用字符串匹配过滤器来匹配异常消息字符串。

public static class LocalLoggingConfiguration
{
    public static void Configure()
    {
        var filter = new StringMatchFilter
        {
            StringToMatch = "An existing connection was forcibly closed by the remote host",
            AcceptOnMatch = false,
        };

        var appender = new ConsoleAppender
        {
            Layout = new SimpleLayout()
        };

        appender.AddFilter(filter);

        BasicConfigurator.Configure(appender);
    }
}

我们配置log4net,获取一个logger,并在测试中进行失败的调用。您会注意到其他级别的几个日志记录和另一个在Error处的日志记录不会与我们的过滤器匹配(如果它有效)。这样,我们就可以确保我们不会意外丢失所有消息。

[TestClass]
public class SocketLibraryTest
{
    private readonly ILog _log = LogManager.GetLogger(typeof(SocketLibraryTest));

    public SocketLibraryTest()
    {
        LocalLoggingConfiguration.Configure();
    }

    [TestMethod]
    public void CatchThatPeskyException()
    {
        _log.Debug("Testing...");

        try
        {
            new SocketThreadWorker().DoWork();
        }
        catch (Exception e)
        {
            _log.Info("An exception!");
            _log.Error("Unexpected exception in SocketThreadWorker", e);
            _log.Error("It wasn't that bad.");
        }
    }
}

在我的环境中,这个测试的输出会将异常和消息分开显示在不同行上。这是因为默认情况下,附加器会以这种方式打印异常对象。
DEBUG - Testing...  
INFO - An exception!  
ERROR - Unexpected exception in SocketThreadWorker  
System.Net.Sockets.SocketException (0x80004005): An existing connection was forcibly closed by the remote host  
   at SO5894291.SocketThreadWorker.DoWork() in d:\users\anthony.mastrean\documents\Projects\SO5894291\SO5894291\SocketLibraryTest.cs:line 16  
   at SO5894291.SocketLibraryTest.CatchThatPeskyException() in d:\users\anthony.mastrean\documents\Projects\SO5894291\SO5894291\SocketLibraryTest.cs:line 58  
ERROR - It wasn't that bad.

如果您修改了附加器过滤器以匹配不同消息的一部分,您会发现它已正确配置并起作用。将字符串更改为匹配"Testing",您会看到DEBUG语句从控制台输出中消失!
建议
您不想匹配通用日志消息"An unexpected exception..."。这有可能丢失消息。即使介绍一个记录器匹配过滤器也无济于事,因为该套接字工作者可能会抛出其他异常(再次潜在地丢失消息)。
我能想到的唯一选择是实现自己的ExceptionMessageToMatchFilter。我已经复制了StringToMatchFilter的实现,替换了渲染消息字符串为异常消息。
public class ExceptionMessageToMatchFilter : StringMatchFilter
{
    public override FilterDecision Decide(LoggingEvent loggingEvent)
    {
        if (loggingEvent == null)
            throw new ArgumentNullException("loggingEvent");

        if (loggingEvent.ExceptionObject == null)
            return FilterDecision.Neutral;

        var exceptionMessage = loggingEvent.GetExceptionString();

        if (m_regexToMatch != null)
        {
            if (!m_regexToMatch.Match(exceptionMessage).Success)
                return FilterDecision.Neutral;

            return m_acceptOnMatch ? FilterDecision.Accept : FilterDecision.Deny;
        }

        if (m_stringToMatch == null || exceptionMessage.IndexOf(m_stringToMatch) == -1)
        {
            return FilterDecision.Neutral;
        }

        return m_acceptOnMatch ? FilterDecision.Accept : FilterDecision.Deny;
    }
}

我建议在调用GetExceptionString()时要小心,不确定它是否会返回null。如果没有消息怎么办(是空的吗?应该返回中性还是继续匹配?)。

在你的log4net配置中设置这个很容易(特别是因为它有所有用于匹配过滤器的字符串属性)。

<filter type="MyNamespace.ExceptionMessageToMatchFilter, MyAssembly">
    <stringToMatch value="An existing connection was forcibly closed by the remote host" />
    <acceptOnMatch value="false" />
</filter>

1
从我添加的appender中可以看出,只有消息而没有异常。目前我无法访问生成日志语句的代码。还有其他想法吗? - Daniel Bäck
2
一个关于downvote的评论会很有帮助。我怎么可能在我已经用代码验证过的答案上downvote? - Anthony Mastrean
非常有用的答案!我刚刚实现了你的日志记录器类,因为我必须对异常进行筛选。 - David Cumps
只想纠正一些东西,在你配置新过滤器的最后一部分,XML 节点应该是“filter”,而不是“appender”。另外,程序集应该简单地是“MyAssembly”,而不是“MyAssembly.dll”。 - e36M3

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接