Serilog:记录不同类型的日志事件

本文关键字：日志 事件 同类型 记录 Serilog | 更新日期: 2023-09-27 18:30:38

我的API被不同类型的消费者访问。有外部应用程序和用户通过Web界面。

我将尝试用一个例子来解释：因此，在方法调用中，我想记录谁或什么访问了它。

如果是外部应用程序，我想记录这样的东西（使用模板）： 

"[{Caller}] {Timestamp:HH:mm:ss} [{Level}] (RequestId:{RequestId} | Key:{Key} | AppVersion:{Version}) {Message}{NewLine}{Exception}"

如果用户触发的操作，我想记录以下内容：

"[{Caller}] {Timestamp:HH:mm:ss} [{Level}] FullName:{FullName} | Organization:{Organization} | AppVersion:{Version}) {Message}{NewLine}{Exception}"

这两种类型的方法调用者都可以从 Thread.CurrentPrincipal.Identity 访问，但每种方法调用方都实现不同类型的标识，具有不同的自定义属性。

我的代码如下所示：

public void DoSomething()
{
    Log.Information("DoSomething called");
}

如果我的记录器配置了类似的东西：

var logger = new LoggerConfiguration()
                   .Enrich.WithProperty("Version", appVersion)
                   .Enrich.WithProperty("Caller", caller)
                   .Enrich.With(new MyEnricher())
                   .WriteTo.ColoredConsole(outputTemplate: "[{Caller}] {Timestamp:HH:mm:ss} [{Level}] FullName:{FullName} | Organization:{Organization} | AppVersion:{Version}) {Message}{NewLine}{Exception}")
                   .CreateLogger();

如果由外部应用程序（线程标识）触发调用，则永远不会显示键和请求 ID。

我在记录器中添加了MyEnricher，如下所示：

public class MyEnricher : ILogEventEnricher
{
    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
    {
        var identity = Thread.CurrentPrincipal.Identity;
        if (identity is ExternalIdentity)
        {
            var externalIdentity = Thread.CurrentPrincipal.Identity as ExternalIdentity;
            logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("Key", externalIdentity.Key));
            logEvent.AddOrUpdateProperty(propertyFactory.CreateProperty("RequestId", externalIdentity.RequestId));
        }
        else
        {
            var userIdentity = Thread.CurrentPrincipal.Identity as UserIdentity;
            logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("FullName", userIdentity.FullName));
            logEvent.AddOrUpdateProperty(propertyFactory.CreateProperty("Organization", userIdentity.OrganizationName));
        }
}

据我从在线文档和示例中掌握的情况，日志记录模板仅在配置记录器时设置，然后才实际创建。我无法通过 LogEvent 在 enricher 中访问和修改模板，因为它是只读的（只有 getter）。

我知道可能的消息格式，但这不是我在这种特殊情况下要找的。

我希望在日志中看到的外部应用程序访问的最终结果如下所示：

17 Jan 2016 10：11：42.524 [API] 10：11：40 [信息] （请求 ID： 123 |钥匙： XXX-1 |应用版本：1.2.1） 做一些叫做

为用户登录时：

17 Jan 2016 11：12：42.524 [WEB] 11：12：40 [信息] （全名：匿名 |组织： 我的组织 |应用版本：1.2.1） 做一些叫做

我的问题是：我如何（如果可能）记录（并在日志中看到）具有不同属性的不同类型的事件来登录模板？是否可以在运行时动态操作模板？我不希望模板包含来自两种或许多其他可能事件类型的所有可能令牌，并且它们的属性在一个地方定义（在一种或另一种情况下，其中许多是空白的）。

Serilog:记录不同类型的日志事件

如果您可以接受与示例略有不同的格式，则可以在此处使用解构：

"[{Caller}] {Timestamp:HH:mm:ss} [{Level}] ({Principal}) {Message}{NewLine}{Exception}"

然后在您的丰富器中：

public class MyEnricher : ILogEventEnricher
{
    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
    {
        var identity = Thread.CurrentPrincipal.Identity;
        if (identity is ExternalIdentity)
        {
            var externalIdentity = Thread.CurrentPrincipal.Identity as ExternalIdentity;
            logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("Principal", new {
                externalIdentity.Key,
                externalIdentity.RequestId
            }, true));
        }
        else
        {
            var userIdentity = Thread.CurrentPrincipal.Identity as UserIdentity;
            logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("Principal", new {
                userIdentity.FullName,
                userIdentity.OrganizationName
            }, true));
        }
    }
}

（请注意触发匿名对象序列化true。

这将以键值对语法输出主体的各种属性。

否则，使用自定义ITextFormatter来执行此操作（基于Serilog的DisplayFormatter的代码）是要走的路。 ColoredConsole不接受自定义文本格式化程序，但是：

WriteTo.Sink(new RollingFileSink(@"Logs'app-{Date}.txt", formatter))

将允许一个通过。

相关文章：