如何让 serilog 丰富器与依赖注入一起工作，同时保持启动？

Question

这里有一个答案：How do I pass a dependency to a Serilog Enricher? 这说明你可以传入一个实例。

但要做到这一点，我需要在我的依赖注入代码运行后移动我的记录器设置（在startup.cs 中）

这意味着不会记录启动错误，因为记录器还没有准备好。

有没有办法以某种方式配置 serilog 以在我的 Main() 方法中运行，但也可以使用 DI 项来丰富数据？ DI 项虽然是单例，但有更多的依赖关系（主要是数据库连接）。

我已经用谷歌搜索了这个并阅读了一些关于将内容添加到上下文中的内容，但我一直无法找到一个我可以适应的完整工作示例。

我发现的大多数示例都涉及将代码放入控制器以附加信息，但我希望这对每个日志条目都是全局可用的。

我的 Main 以 :

开头

Log.Logger = new LoggerConfiguration()
    .Enrich.FromLogContext()
    .WriteTo.Elasticsearch(new ElasticsearchSinkOptions(new Uri(elasticUri))
    {
        AutoRegisterTemplate = true,
    })
    .CreateLogger();

在进入 .NET Core MVC 代码之前

CreateWebHostBuilder(args).Build().Run();

我的 DI 对象基本上是一个“UserData”类，其中包含用户名、公司 ID 等，这些属性是在访问时访问数据库以获取基于某些当前身份的值的属性（尚未实现）。它被我的 DI 注册为单例。

Answer 1

我建议使用插入到 ASP .NET Core 管道中的简单中间件，使用所需的数据来丰富 Serilog 的 LogContext，使用所需的依赖项，让 ASP .NET Core 依赖项注入解决对你的依赖...

例如假设 IUserDataService 是一项服务，您可以使用它来获取所需的数据，以丰富日志，中间件看起来像这样：

public class UserDataLoggingMiddleware
{
    private readonly RequestDelegate _next;

    public UserDataLoggingMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context, IUserDataService userDataService)
    {
        var userData = await userDataService.GetAsync();

        // Add user data to logging context
        using (LogContext.PushProperty("UserData", userData))
        {
            await _next.Invoke(context);
        }
    }
}

上面的LogContext.PushProperty 正在做丰富，将一个名为UserData 的属性添加到当前执行的日志上下文中。

只要您在Startup.ConfigureServices 中注册了IUserDataService，ASP .NET Core 就会负责解析它。

当然，要让它发挥作用，您必须：

1。通过调用Enrich.FromLogContext()，告诉 Serilog 从 Log 上下文中丰富日志。例如

Log.Logger = new LoggerConfiguration()
    .ReadFrom.Configuration(Configuration)
    .Enrich.FromLogContext() // <<======================
    .WriteTo.Console(
        outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} " +
                        "{Properties:j}{NewLine}{Exception}")
    .CreateLogger();

2。将您的中间件添加到管道中，在您的 Startup.Configure 中。例如

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    // ...

    app.UseMiddleware<UserDataLoggingMiddleware>();

    // ...

    app.UseMvc();
}

Answer 2

对已接受答案的轻微改进是使用 ILogger.BeginScope 而不是静态 Serilog LogContext.PushProperty。字典变得有点难看，但仍然是一个改进，并且与记录器无关。

public async Task Invoke(HttpContext context, IUserDataService userDataService, ILogger<UserDataLoggingMiddleware> logger)
{
    var userData = await userDataService.GetAsync();

    // Add user data to logging context
    using (logger.BeginScope(new Dictionary<string, object> { ["UserData"] = userData }))
    {
        await _next.Invoke(context);
    }
}