log4net 附加说明
正在SocketThreadWorker
投掷. SocketException
异常消息“远程主机强制关闭现有连接”由错误代码映射。
throw new SocketException(10054);
生成日志语句的代码看起来像一个未处理的异常处理程序(由打印的消息“意外异常...”)。但是,对于这个答案,想象它看起来像这样
try
{
...
}
catch (Exception e)
{
_log.Error("Unexpected exception in SocketThreadWorker", e);
}
log4net 在幕后产生的是一个LoggingEvent
. 它包含提供的日志消息和异常对象(分别)。每个 appender 可以决定如何将这两个项目写入它们的最终目的地(以及其他属性、布局参数等)。
过滤器StringToMatch
仅适用于日志消息。不在异常消息上!看看下面这段代码,我们将构建一个系统和一个测试来帮助我们调试问题
复制和深潜
这是一个简单的套接字异常抛出类
public class SocketThreadWorker
{
public void DoWork()
{
throw new SocketException(10054);
}
}
我们将配置 log4net 以使用ConsoleAppender
带有字符串匹配过滤器的 a,匹配异常消息字符串。
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.");
}
}
}
在我的环境中,此测试的输出包含与消息不同的行中的异常,因为默认情况下,appender 将以这种方式打印异常对象。
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.
如果您修改 appender 过滤器以匹配不同消息的一部分,您将看到它已正确配置并且可以正常工作。将字符串更改为“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>