nlog异常布局,用于格式化异常类型,消息和堆栈跟踪

时间:2017-10-04 13:04:06

标签: c# exception nlog

请帮我格式化使用文件记录器记录的异常 我希望在内部异常(如果有)之间使用新行分隔符记录异常,异常类型包含一些特殊符号,例如[ArgumentException]以使其与错误文本不同,以及预期的异常使用tab只是为了便于阅读堆栈跟踪

我已经检查了最新的NLog 4.4.12软件包,但问题是参数化默认布局并不容易得到类似

的内容
2017-10-04 15:13:22.5823 NLogTest.Program starting
2017-10-04 15:13:22.5823 NLogTest.Program failed to start NLogTest
    [ArgumentException] bad try 
       at NLogTest.Classes.UnitOfWork.tryException() in d:\projects\NLogTest\Program.cs:line 62
       at NLogTest.Program.Main(String[] args) in d:\projects\NLogTest\Program.cs:line 19
    [ArgumentException] outer exception
       at NLogTest.Classes.UnitOfWork.outerException() in d:\projects\NLogTest\Program.cs:line 49
       at NLogTest.Classes.UnitOfWork.tryException() in d:\projects\NLogTest\Program.cs:line 57
    [KeyNotFoundException] innerException
       at NLogTest.Classes.UnitOfWork.innerException() in d:\projects\NLogTest\Program.cs:line 38
       at NLogTest.Classes.UnitOfWork.outerException() in d:\projects\NLogTest\Program.cs:line 45
2017-10-04 15:13:22.5823 NLogTest.Program the end

这是我想要的异常文件日志。 我尝试过像

这样的布局
layout="${longdate} ${logger} ${message}${onexception:${newline}${exception:format=tostring}}"

它使用标准的tostring异常方法但结果却不一样。我不喜欢那个

2017-10-04 15:28:52.6881 NLogTest.Program failed to start NLogTest
System.ArgumentException: bad try ---> System.ArgumentException: outer exception ---> System.Collections.Generic.KeyNotFoundException: innerException
   at NLogTest.Classes.UnitOfWork.innerException() in d:\projects\NLogTest\Program.cs:line 40
   at NLogTest.Classes.UnitOfWork.outerException() in d:\projects\NLogTest\Program.cs:line 47
   --- End of inner exception stack trace ---
   at NLogTest.Classes.UnitOfWork.outerException() in d:\projects\NLogTest\Program.cs:line 51
   at NLogTest.Classes.UnitOfWork.tryException() in d:\projects\NLogTest\Program.cs:line 59
   --- End of inner exception stack trace ---
   at NLogTest.Classes.UnitOfWork.tryException() in d:\projects\NLogTest\Program.cs:line 64
   at NLogTest.Program.Main(String[] args) in d:\projects\NLogTest\Program.cs:line 20

内部异常消息堆栈跟踪在日志中分离(因此以后很难读取日志)以防异常重新抛出超过两次 并且在例外类型名称之前没有制表符(空格)。

我得到的最好结果是布局

layout="${longdate} ${logger} ${message}${onexception:${newline}${exception:maxInnerExceptionLevel=10:format=shortType,message,stacktrace:separator=*:innerExceptionSeparator=
	}}"

,它是

2017-10-04 15:49:02.6188 NLogTest.Program failed to start NLogTest
ArgumentException*bad try*   at NLogTest.Classes.UnitOfWork.tryException() in d:\projects\NLogTest\Program.cs:line 64
   at NLogTest.Program.Main(String[] args) in d:\projects\NLogTest\Program.cs:line 20
    ArgumentException*outer exception*   at NLogTest.Classes.UnitOfWork.outerException() in d:\projects\NLogTest\Program.cs:line 51
   at NLogTest.Classes.UnitOfWork.tryException() in d:\projects\NLogTest\Program.cs:line 59
    KeyNotFoundException*innerException*   at NLogTest.Classes.UnitOfWork.innerException() in d:\projects\NLogTest\Program.cs:line 40
   at NLogTest.Classes.UnitOfWork.outerException() in d:\projects\NLogTest\Program.cs:line 47

但是很难阅读。第一个堆栈跟踪线与异常消息在同一行。内部错误消息是打算但内部堆栈跟踪 - 没有。

我错过了布局中的任何内容吗? 我应该create custom exception layout renderer吗? 我用来引发异常的Here is c#源代码

1 个答案:

答案 0 :(得分:2)

编写NLog布局渲染器非常简单,因此我设法创建了异常布局渲染器,它完全按照请求格式化异常。

最新的自定义布局源代码版本可以是found on gist 控制台和文件记录器is available also的示例配置。

此外,我添加了堆栈跟踪过滤器。有时异常会被记录多次。可能是因为设计不好(异常应该只记录一次),或者因为可以从外部代码中使用相同的方法(因此异常应该在被抛出之前在本地记录)或者在同一解决方案中使用其他方法。在这种情况下,内部异常可以被记录多次。为了减少堆栈跟踪,如果以前记录了异常,我添加了跳过堆栈跟踪日志记录的可能性。在这种情况下,仅记录异常类型和消息。如下所示:

[1] 2017-10-04 16:55:17.2227 Debug NLogTest.Program starting
[1] 2017-10-04 16:55:17.2527 Error NLogTest.Classes.UnitOfWork tryException failure
    [ArgumentException] outer exception
        at NLogTest.Classes.UnitOfWork.outerException() in d:\projects\NLogTest\Program.cs:line 48
        at NLogTest.Classes.UnitOfWork.tryException() in d:\projects\NLogTest\Program.cs:line 56
    [KeyNotFoundException] innerException
        at NLogTest.Classes.UnitOfWork.innerException() in d:\projects\NLogTest\Program.cs:line 37
        at NLogTest.Classes.UnitOfWork.outerException() in d:\projects\NLogTest\Program.cs:line 44
[1] 2017-10-04 16:55:17.2697 Error NLogTest.Program failed to start NLogTest
    [ArgumentException] bad try
        at NLogTest.Classes.UnitOfWork.tryException() in d:\projects\NLogTest\Program.cs:line 61
        at NLogTest.Program.Main(String[] args) in d:\projects\NLogTest\Program.cs:line 17
    [ArgumentException] outer exception
    [KeyNotFoundException] innerException

外部异常和innerException被记录两次。第一次捕获外部异常,第二次记录为内部异常。 但是,由于日志包含堆栈跟踪,因此仅记录异常类型和消息。