依赖注入下多后台服务的日志分离配置问题

核心问题分析 #

你当前的Serilog配置仅通过SourceContext过滤后台服务自身的日志，但依赖类（如ClientHandler、AddressHandler）的日志SourceContext是其自身类型（比如Mtp.App.Handlers.ClientHandler），无法被关联到所属的后台服务，因此这些日志不会写入对应服务的日志文件。

解决方案：通过日志上下文标记服务归属 #

最简洁可靠的方式是利用Serilog LogContext为后台服务的所有操作添加统一标识，再基于该标识过滤日志。

步骤1：启用LogContext enrichment #

在Serilog根配置中添加日志上下文增强，确保自定义属性能被捕获：

"Serilog": {
  "Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.File", "Serilog.Sinks.Async", "Serilog.Expressions" ],
  "Enrich": ["FromLogContext"], // 新增日志上下文增强
  "MinimumLevel": {
    "Default": "Verbose",
    "Override": {
      "Microsoft": "Information",
      "Microsoft.AspNetCore": "Warning",
      "Microsoft.AspNetCore.Hosting.Diagnostics": "Warning",
      "System.Net.Http.HttpClient": "Warning"
    }
  },
  // 其余原有配置保持不变
}

步骤2：在后台服务中注入服务标识 #

修改后台服务的ExecuteAsync方法，用LogContext.PushProperty添加唯一的服务名称属性，该代码块内的所有日志（包括依赖类的日志）都会自动带上这个属性：

public class SimpleBackgroundService: BackgroundService
{
    private readonly IServiceProvider _serviceProvider;
    private readonly ILogger<SimpleBackgroundService> _logger;
    private readonly ClientHandler _clientHandler;
    private readonly AddressHandler _addressHandler;

    // 构造函数保持原有注入逻辑

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        // 推送服务名称到日志上下文，作用域覆盖整个服务生命周期
        using (LogContext.PushProperty("ServiceName", nameof(SimpleBackgroundService)))
        {
            while (!stoppingToken.IsCancellationRequested)
            {
                _logger.LogInformation("SimpleBackgroundService 正在运行");
                _clientHandler.HandleClient(); // 该方法内的日志会自动携带ServiceName属性
                await Task.Delay(TimeSpan.FromSeconds(10), stoppingToken);
            }
        }
    }
}

对SecondSimpleBackgroundService执行同样修改，推送ServiceName为nameof(SecondSimpleBackgroundService)。

步骤3：修改Serilog过滤规则 #

将原来基于SourceContext的过滤替换为自定义ServiceName属性的过滤，确保所有带有该服务标识的日志都写入对应文件：

"WriteTo": [
  {
    "Name": "Logger",
    "Args": {
      "configureLogger": {
        "Filter": [
          {
            "Name": "ByIncludingOnly",
            "Args": {
              "expression": "ServiceName = 'SecondSimpleBackgroundService'"
            }
          }
        ],
        "WriteTo:Async": {
          "Name": "Async",
          "Args": {
            "configure": [
              {
                "Name": "File",
                "Args": {
                  "path": "./logs/second_service_log.json", // 对应服务的专属日志路径
                  "rollingInterval": "Day",
                  "rollOnFileSizeLimit": true,
                  "fileSizeLimitBytes": 20971520,
                  "retainedFileCountLimit": 50,
                  "formatter": {
                    "type": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact"
                  }
                }
              }
            ]
          }
        }
      }
    }
  },
  {
    "Name": "Logger",
    "Args": {
      "configureLogger": {
        "Filter": [
          {
            "Name": "ByIncludingOnly",
            "Args": {
              "expression": "ServiceName = 'SimpleBackgroundService'"
            }
          }
        ],
        "WriteTo:Async": {
          "Name": "Async",
          "Args": {
            "configure": [
              {
                "Name": "File",
                "Args": {
                  "path": "./logs/simple_service_log.json", // 对应服务的专属日志路径
                  "rollingInterval": "Day",
                  "rollOnFileSizeLimit": true,
                  "fileSizeLimitBytes": 20971520,
                  "retainedFileCountLimit": 50,
                  "formatter": {
                    "type": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact"
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
]

额外说明 #

• 若不需要单独的Handlers日志文件，可删除原有针对Mtp.App.Handlers的过滤配置，这些日志现在会通过ServiceName归属到对应后台服务的日志中。
• 确保所有依赖类的日志均通过DI注入的ILogger<T>写入，才能自动继承LogContext中的属性。

内容的提问来源于stack exchange，提问作者Саня Санчоус