C#怎么实现日志记录功能 C#如何用NLog和Serilog记录程序运行日志和异常信息【工具】

千辰同学_4764

千辰同学_4764

2026-04-15

735人浏览

原创

在C#项目中快速接入NLog只需NuGet安装并配置nlog.config文件,设为“始终复制”,用${basedir}/logs/${shortdate}.log路径;Serilog需手动注册全局异常处理器并调用UseSerilog()替换原生日志系统。

c#怎么实现日志记录功能 c#如何用nlog和serilog记录程序运行日志和异常信息【工具】

怎么在 C# 项目里快速接入 NLog 并输出到文件

直接用 NuGet 安装 NLog 包,再配一个 nlog.config 文件就能跑起来,不用改一行代码逻辑。关键在于配置文件的写法和日志级别控制。

  • 安装命令:dotnet add package NLog(.NET CLI)或通过 Visual Studio NuGet 管理器搜索安装
  • nlog.config 必须设为“复制到输出目录:始终复制”,否则运行时找不到配置
  • 默认日志级别是 Info,Debug 级别日志不会写入,调试时记得调高 minlevel
  • 文件目标路径建议用 ${basedir}/logs/${shortdate}.log,避免硬编码路径;Windows 和 Linux 路径分隔符由 NLog 自动处理

示例配置片段(nlog.config 中的 部分):

<target xsi:type="File" name="file" filename="${basedir}/logs/${shortdate}.log" layout="${longdate} ${uppercase:${level}} ${logger} ${message} ${exception:format=tostring}"></target>

Serilog 怎么捕获未处理异常并自动记录堆栈

Serilog 本身不监听全局异常,必须手动挂载 AppDomain.CurrentDomain.UnhandledException 或 TaskScheduler.UnobservedTaskException,否则程序崩溃时日志就断了。

  • 在 Program.cs 最早位置(如 Main 开头)调用 Log.Logger = new LoggerConfiguration().CreateLogger()
  • 注册全局异常处理器:AppDomain.CurrentDomain.UnhandledException += (s, e) => Log.Fatal(e.ExceptionObject as Exception, "Unhandled exception");
  • 异步任务异常容易漏掉,务必加 TaskScheduler.UnobservedTaskException 处理
  • WriteTo.Console() 默认不显示异常详情,要加 outputTemplate 或用 RenderedCompactJsonFormatter 才能完整输出 Exception.ToString()

推荐初始化写法:

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Debug()
    .WriteTo.Console(outputTemplate: "{Timestamp:HH:mm:ss} [{Level:u3}] {Message:lj}{NewLine}{Exception}")
    .WriteTo.File("logs/log-.txt", rollingInterval: RollingInterval.Day)
    .CreateLogger();

NLog 和 Serilog 在 ASP.NET Core 里的注册方式有什么区别

两者都支持 ILoggingBuilder 扩展,但 Serilog 是“替换”原生日志系统,NLog 是“接入”原生系统,这直接影响 ILogger 的行为和性能开销。

  • NLog:调用 builder.Host.UseNLog() 即可,后续仍用 Microsoft.Extensions.Logging.ILogger,兼容所有中间件日志输出
  • Serilog:必须用 Host.CreateDefaultBuilder().UseSerilog(),且要在 WebHostBuilder 构建前注册,否则 ILogger 实例会是空壳
  • Serilog 的 Log.Error(ex, ...) 和 logger.LogError(ex, ...) 输出内容一致;NLog 的 logger.Error(ex, ...) 需确保 layout 中包含 ${exception} 才能渲染堆栈
  • ASP.NET Core 的请求日志(如 Microsoft.AspNetCore.Hosting.Diagnostics)默认级别是 Information,若想看到详细请求耗时,需在配置中显式开启 Microsoft.AspNetCore 命名空间的日志

为什么日志文件没生成、或者只写了一两行就停了

最常见原因是权限不足、路径不可写、或日志组件被提前释放。尤其在 Windows 服务、IIS 或 Docker 容器中,工作目录和权限模型和开发环境完全不同。

  • NLog:检查 nlog.config 中 keepFileOpen="false"(默认 true),IIS 下多个 w3wp 进程争抢文件锁会导致写入失败
  • Serilog:如果用了 WriteTo.File() 但没指定 shared: true,多进程场景下会抛 IOException 并静默失败
  • .NET 6+ 的 Minimal Hosting 模式下,若在 WebApplication.CreateBuilder() 之前调用 Log.Logger,会触发静态构造器初始化失败,日志直接丢失
  • Docker 容器中挂载日志目录时,宿主机路径需有写权限,且容器内用户 UID 需匹配(例如 Alpine 镜像常用 www-data 用户)

排查技巧:临时把 target 改成 Console 或 Debug,看是否真有日志产生;再查 NLog 内置的 internalLogLevel 或 Serilog 的 SelfLog.Enable(...) 输出诊断信息。

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

1092

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

3191

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

905

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2655

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

332

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

429

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

631

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gradle 安全最佳实践
Gradle 安全最佳实践

共0课时 | 0人学习

Gradle Wrapper 使用与安全指南
Gradle Wrapper 使用与安全指南

共0课时 | 0人学习

Golangci-lint命令行使用演示
Golangci-lint命令行使用演示

共0课时 | 0人学习