ASP.NET Core 5.0中NLog的ClearProviders与OutputDebugString等调试方案区别

1. 删除logging.ClearProviders()方案 #

logging.ClearProviders()的作用是清空ASP.NET Core默认注册的所有日志提供器，其中就包含负责输出到VS Debug窗口、诊断Events窗口的默认Debug日志提供器、诊断日志提供器。删除该行后，默认提供器会保留，日志会同时走默认提供器、NLog提供器两条链路输出。

• 合理性：该方案完全可用，更适合仅在开发环境临时调试的场景
• 优缺点：无需修改NLog配置，操作最简单；但默认提供器的日志输出不受NLog配置管控，需要单独配置过滤、格式化规则，容易出现日志重复输出、规则不一致的问题

2. NLog Debugger Target方案 #

该Target是NLog原生实现的调试输出目标，底层调用.NET标准库的System.Diagnostics.Debugger.Log()方法实现输出。

• 生效条件：仅当进程被调试器附加（即VS调试运行状态）时才会输出日志，无调试器附加时输出内容会直接丢弃，无额外性能损耗
• 优缺点：完全受NLog配置管控，可自定义日志格式、过滤规则，不会和其他日志链路冲突；支持跨平台，Windows、Mac、Linux下的VS、Rider等调试工具都能正常捕获输出

3. NLog OutputDebugString Target方案 #

该Target底层调用Windows系统API的OutputDebugString()实现输出，是Windows平台专属方案。

• 生效条件：不依赖.NET调试器接口，只要有支持监听OutputDebugString的工具运行就能捕获日志，除了VS之外，DebugView等第三方工具也能抓到对应输出
• 优缺点：同样完全受NLog配置管控，适用场景更灵活；但仅支持Windows平台，无监听工具时调用系统API仍会产生少量额外性能开销

选型建议 #

• 仅开发临时调试、不想调整NLog配置：选择删除logging.ClearProviders()即可
• 需要统一NLog管控所有日志规则、跨平台开发：优先选择Debugger Target
• Windows平台专属开发、需要第三方工具捕获调试日志：选择OutputDebugString Target

内容的提问来源于stack exchange，提问作者tony