如何配置Azure Log Stream以显示NLog格式化的.NET Core Web API日志

为什么Azure Log Stream没有展示你配置的格式化输出 #

匹配你遇到的「黑底白字、自定义布局内容缺失」现象，核心原因有三点：

• Azure Log Stream 并非直接对接进程的交互式Console终端：它的采集链路是App Service运行时把托管进程的标准输出流（stdout）重定向到服务器本地的文本日志文件，再由日志服务实时读取文件新增内容推送到前端页面，整个链路没有交互式TTY终端的存在。
• NLog的ColoredConsole目标内置了TTY环境检测逻辑：只要检测到输出流被重定向（也就是Azure托管环境下的场景），就会自动关闭颜色渲染分支，且部分版本的NLog在这种重定向场景下会出现兼容问题，跳过自定义layout的渲染逻辑，直接输出框架默认格式的日志内容，这就是你看不到自定义布局的直接原因。
• 你在Startup中移除AddConsole()的操作，进一步放大了日志管道断裂的问题：如果没有正确将NLog提供程序完全接管ASP.NET Core的日志管道，NLog生成的日志事件根本不会触发ColoredConsole目标的写入，Azure Log Stream抓到的就只有Kestrel、运行时自身输出的默认格式日志，自然看不到你自定义的内容。

Azure Log Stream是否会原样呈现Console输出？ #

不会，它和本地交互式Console的表现有本质区别：

• 本地Console存在真实的TTY终端，支持解析ANSI颜色转义码，可以实现你配置的日志级别彩色高亮效果
• Azure Log Stream的前端展示层默认不解析ANSI转义序列，就算你强制让NLog输出带颜色控制符的内容，推送到页面后也只会显示黑底白字，甚至夹带不可读的转义符残留，不会产生任何高亮效果
• 因为链路中间隔了一层文件重定向，所有依赖TTY交互的Console特性（颜色渲染、光标控制、行清屏）在Log Stream上都无法生效

正确的配置方案，实现本地与Azure Log Stream格式一致 #

按照下面的步骤调整即可：

• 把NLog的输出目标从ColoredConsole替换为普通Console目标

  普通Console目标没有TTY检测逻辑，会严格按照你配置的${var_layout}把纯文本内容写入进程stdout，不会额外跳转格式，也不会输出无意义的ANSI转义符，从根源避免自定义布局丢失的问题。

• 不要完全移除AddConsole()配置

  把AddConsole()保留在日志管道注册逻辑中，再配合NLog的自定义提供程序接管日志事件渲染，既可以让NLog按照你定义的格式生成纯文本日志，也能确保渲染后的内容正常写入stdout被Azure采集，不会出现管道断裂导致日志丢失的问题。

• 开启App Service的应用层日志采集

  在App Service的日志配置面板中，启用文件系统类型的应用程序日志，设置合理的日志保留周期，确保运行时会正确重定向并采集进程的stdout输出。

• 不要在跨环境的日志配置中依赖颜色高亮特性

  如果需要在不同环境快速区分日志级别，可以在自定义layout中把日志级别、错误标记等关键字段作为纯文本嵌入日志内容，不需要依赖TTY的颜色能力，就能保证本地Console和Azure Log Stream的展示格式完全统一。

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