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>