将自定义属性添加到 Serilog

本文关键字：Serilog 添加 自定义属性 | 更新日期: 2023-09-27 18:37:02

我正在应用程序中将Serilog与MS SQL Server接收器一起使用。假设我已经定义了以下类...

public class Person
{
  public string FirstName { get; set; }
  public string LastName { get; set; }
  public DateTime BirthDate { get; set; }
  // ... more properties
}

。并创建了一个实例：

var person = new Person
{
    FirstName = "John",
    LastName = "Doe",
    BirthDate = DateTime.UtcNow.AddYears(-25)
};

我在代码中放置了以下日志调用：

Log.Information("New user: {FirstName:l} {LastName:l}",
    person.FirstName, person.LastName);

是否可以在不将其添加到消息模板的情况下记录 BirthDate 属性，以便在 Properties XML 列中呈现它？我想稍后在应用程序日志查看器的详细信息视图中输出它。

我基本上正在寻找类似于对象解构的行为，但没有将平面对象打印为日志消息的一部分。

将自定义属性添加到 Serilog

这很简单：

Log.ForContext("BirthDate", person.BirthDate)
   .Information("New user: {FirstName:l} {LastName:l}",
                           person.FirstName, person.LastName);

您实际上可以通过几种不同的方式执行此操作。在您的情况下，第一种方法可能是最好的：

Log.ForContext("BirthDate", person.BirthDate)
    .Information("New user: {FirstName:l} {LastName:l}",
        person.FirstName, person.LastName);

但您也可以在其他方案中使用该LogContext：

Log.Logger = new LoggerConfiguration()
    // Enrich all log entries with properties from LogContext
    .Enrich.FromLogContext();
using (LogContext.PushProperty("BirthDate", person.BirthDate))
{
    Log.Information("New user: {FirstName:l} {LastName:l}",
        person.FirstName, person.LastName);
}

或者，如果要记录"常量"属性，可以像这样添加它：

Log.Logger = new LoggerConfiguration()
    // Enrich all log entries with property
    .Enrich.WithProperty("Application", "My Application");

有关详细信息，请参阅 .NET 中的上下文和关联 – 结构化日志记录概念 （5）。

如果您使用的是通用Microsoft ILogger 接口，则可以使用 BeginScope;

using (_logger.BeginScope(new Dictionary<string, object> { { "LogEventType", logEventType }, { "UserName",  userName } }))
{
    _logger.LogInformation(message, args);
}

这里讨论了这一点;https://blog.rsuter.com/logging-with-ilogger-recommendations-and-best-practices/

相关文章：