log4net - 如何使用 stringToMatch 过滤器将消息与 log4net 中的换行符进行匹配？

Question

我在配置 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 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>

我不想通知任何人有关此错误消息，因为它确实没有那么严重。该消息不是由我自己的代码生成的，而是来 self 使用的库。

Answer 1

log4net追加说明

SocketThreadWorker 正在抛出 SocketException 。异常消息“现有连接被远程主机强制关闭”由 error code 映射。 .

throw new SocketException(10054);

生成日志语句的代码看起来像一个未处理的异常处理程序(通过打印消息“意外异常...”)。但是，对于这个答案，想象一下它看起来像这样

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

log4net 在幕后生成的是 LoggingEvent 。它包含提供的日志消息和异常对象(分别)。每个附加程序都可以决定如何将这两个项目写入其最终目的地(以及其他属性、布局参数等)。

StringToMatch 过滤器仅适用于日志消息。不就异常信息了!查看下面的代码，我们将构建一个系统和一个测试来帮助我们调试问题

再现和深入研究

这是一个简单的套接字异常抛出类

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，获取记录器，并在测试中进行失败的调用。您会注意到其他级别的一些日志语句和 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 语句从控制台输出中消失!

建议

您不想匹配通用日志消息“意外异常...”。这有机会丢失消息。即使引入记录器匹配过滤器也无济于事，因为套接字工作人员可能会抛出其他异常(同样，可能会丢失消息)。

我能想到的唯一选择是实现您自己的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>