Serilog：记录不同类型的日志事件答案

【问题标题】：Serilog: Logging different types of log eventsSerilog：记录不同类型的日志事件
【发布时间】：2016-04-22 14:20:37
【问题描述】：

我的 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();

如果被外部应用程序（线程标识）触发调用，它永远不会显示 Key 和 RequestId。

我在记录器中添加了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 访问和修改丰富器中的模板，因为它是只读的（只有 getter）。

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

对于外部应用访问，我希望在日志中看到的最终结果类似于：

2016 年 1 月 17 日 10:11:42.524 [API] 10:11:40 [信息] (RequestId: 123 | Key: XXX-1 | AppVersion:1.2.1) DoSomething 调用

当为用户登录时：

2016 年 1 月 17 日 11:12:42.524 [WEB] 11:12:40 [信息]（全名：匿名 | 组织：MyOrg | AppVersion:1.2.1）DoSomething 调用

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

【问题讨论】：

标签： c# .net logging serilog

【解决方案1】：

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

"[{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))

将允许一个人通过。

【讨论】：