Serilog在.NET 8 Windows服务中的最佳实践

背景介绍

Serilog作为.NET生态中广受欢迎的日志记录库，在Windows服务应用中有着广泛的应用场景。特别是在基于.NET 8的Windows服务开发中，结合BackgroundService类和Worker模板使用时，正确配置Serilog对于确保日志记录可靠性至关重要。

核心问题分析

在Windows服务环境中使用Serilog时，开发者常遇到日志文件无法写入的问题。这主要是因为服务运行时的当前工作目录与开发环境不同，且服务账户可能没有对默认路径的写入权限。

解决方案详解

1. 日志文件路径配置

在Windows服务中，必须使用绝对路径来指定日志文件位置。推荐使用以下方式之一：

• 系统专用目录：如Environment.SpecialFolder.CommonApplicationData
• 自定义应用数据目录：在程序安装目录下创建专门的logs子目录

var logPath = Path.Combine(
    Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData),
    "YourAppName",
    "logs",
    "log.txt");

2. 完整配置示例

以下是适用于.NET 8 Windows服务的完整Serilog配置：

var builder = Host.CreateApplicationBuilder(args);

// 初始化引导日志记录器
Log.Logger = new LoggerConfiguration()
    .WriteTo.Console()
    .CreateBootstrapLogger();

try
{
    // 构建最终日志配置
    var logPath = Path.Combine(
        Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData),
        "YourAppName",
        "logs",
        "log.txt");
    
    // 确保目录存在
    Directory.CreateDirectory(Path.GetDirectoryName(logPath));

    builder.Logging.ClearProviders();
    builder.Logging.AddSerilog(new LoggerConfiguration()
        .ReadFrom.Configuration(builder.Configuration)
        .WriteTo.File(
            path: logPath,
            rollingInterval: RollingInterval.Day,
            retainedFileCountLimit: 7)
        .WriteTo.Console()
        .CreateLogger());

    // 服务配置
    builder.Services.AddWindowsService(options => 
    {
        options.ServiceName = "Your Service Name";
    });
    
    // 其他服务注册...
    
    var host = builder.Build();
    host.Run();
}
catch (Exception ex)
{
    Log.Fatal(ex, "应用程序启动失败");
}
finally
{
    Log.CloseAndFlush();
}

3. 配置文件(appsettings.json)优化

{
  "Serilog": {
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    },
    "WriteTo": [
      {
        "Name": "Console"
      }
    ]
  }
}

注意：文件路径建议在代码中动态构建，而不是放在配置中。

高级实践建议

1. 日志轮转策略：配置合理的日志文件轮转策略，避免磁盘空间被占满
2. 权限管理：确保服务运行账户对日志目录有写入权限
3. 异常处理：完善全局异常捕获，确保关键错误能被记录
4. 性能考虑：在高频日志场景下，考虑使用异步写入方式

常见问题排查

1. 日志文件未创建：检查目录权限和服务账户
2. 日志内容缺失：确认MinimumLevel设置合理
3. 服务启动失败：查看Windows事件日志获取详细错误
4. 日志格式问题：通过Enrich丰富日志上下文信息

通过以上配置和实践，开发者可以确保Serilog在.NET 8 Windows服务中稳定可靠地工作，为应用提供完整的日志记录能力。