c# - 记录异常属性

Question

是否可以使用 NLog 记录异常属性？

例如，SocketException 具有诸如 ErrorCode、HResult、NativeErrorCode 等仅特定于此类异常的属性。是否可以在不显式记录(即不使用 Log(e.ErrorCode))它们并仅使用代码中的 ErrorException 的情况下记录它们？默认 Exception layout renderer只是在异常时调用 ToString。

Answer 1

我不知道这是否是个好主意，但您可以编写自己的 LayoutRenderer。为了简单起见，我只编写了一个继承自 ExceptionLayoutRenderer 并覆盖 Append 方法的方法。

[LayoutRenderer("ExtendedException")]
    public class ExtendedExceptionLayoutRenderer : ExceptionLayoutRenderer
    {
        protected override void Append(System.Text.StringBuilder builder, LogEventInfo logEvent)
        {
            base.Append(builder, logEvent);

            var exception = logEvent.Exception;
            if (exception is SocketException)
            {
                var sockException = (SocketException) exception;
                builder.Append(sockException.ErrorCode).Append(" ").Append(sockException.SocketErrorCode);
            }
        }
    }

SocketException 的处理不是很复杂。我确信有更好的方法，但它展示了您如何做到这一点。

要激活它，您必须像这样调整您的配置:

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <extensions>
        <add assemblyFile="YourAssembly.dll"/>
    </extensions>

    <targets>
        <target name="console" xsi:type="Console" layout="${extendedexception} ${message}"/>
    </targets>

    <rules>
        <logger name="*" minlevel="Debug" writeTo="console" />
    </rules>
</nlog>

编辑

好的，我不知道您想要为每个具有自己属性的异常使用该功能。如果您只对其他几个感兴趣，则可以添加更多 if(exception is YourExceptionType) 并调整您感兴趣的属性。一种更通用的方法是使用反射来记录在异常上定义的所有属性。

[LayoutRenderer("ExtendedException")]
    public class ExtendedExceptionLayoutRenderer : ExceptionLayoutRenderer
    {
        protected override void Append(System.Text.StringBuilder builder, LogEventInfo logEvent)
        {
            var exception = logEvent.Exception;
            var type = exception.GetType();
            var properties = type.GetProperties(BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Public);

            var logEntries = new SortedDictionary<string, string>();

            foreach (var property in properties)
            {
                var name = property.Name;
                var value = property.GetValue(exception, null).ToString();
                logEntries.Add(name, value);
            }

            foreach (var entry in logEntries)
            {
                builder.AppendFormat("{0}: {1} ", entry.Key, entry.Value);
            }

            base.Append(builder, logEvent);
        }
    }

这会将在异常类型上声明的每个属性按字母顺序添加到日志输出中。