Serilog：请求 ID 实现

Question

最近我已将 Serilog 配置为与 ASP.NET Core 2 MVC 应用程序配合使用，下一个任务是在系统的每一层上跟踪对 Web 应用程序的传入请求。所以基本上，我们想要传播一些令牌（比如由 Serilog 生成的RequestId 到较低层的应用程序）。

"Serilog": {
    "Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.RollingFile" ],
    "MinimumLevel": {
      "Default": "Debug",
      "Override": {
        "Microsoft": "Warning"
      }
    },
    "WriteTo": [
      {
        "Name": "RollingFile",
        "Args": {
          "pathFormat": "log-{Hour}.txt",
          "fileSizeLimitBytes": "",
          "retainedFileCountLimit": "",
          "outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Application}] [{Level}] [{RequestId}] - {Message}{NewLine}{Exception}"
        }
      }
    ],
    "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
    "Properties": {
      "Application": "MultilayerApp"
    }
},

在日志中我们有很好的输入，比如

2018-01-19 14:06:01.165 +00:00 [App] [Warning] [0HLAV6PIMA9M0:00000001] - Accessing expired session, Key:"6e7f3ab5-db62-335d-1bc7-6824e5b918f5"

但我的问题是，在 Serilog 中，RequestId 浓缩器的实现在哪里？老实说，我找不到它。

Answer 1

在 ASP.NET Core 中，一些记录器暴露的RequestId 是HttpContext 上的TraceIdentifier 的值。此属性可在整个应用程序中用于识别当前请求。

出于日志记录的目的，回退到HttpContext 并不是要走的路。 Microsoft.Extensions.Logging 抽象支持 logging scopes，这是一种向适用于该范围内的记录器提供附加信息的方法。

默认情况下，ASP.NET Core 打开了两个日志记录范围。其中之一是打开 at the beginning of every request 的 HostingLogScope（如果至少启用了关键日志记录）。

记录器可以通过实现BeginScope method 来访问信息，该HostingLogScope 对象在每次请求开始时传递给它，并简单地遍历对象直到找到属性：

string requestId = null;
if (state is IEnumerable<KeyValuePair<string, object>> properties)
{
    foreach (var property in properties)
    {
        if (property.Key == "RequestId")
        {
            requestId = property.Value as string;
        }
    }
}

Serilog does pretty much the same 但存储所有属性 in the log event。这就是为什么您没有找到对 RequestId 的显式引用，但是当您指定要包含它的日志记录字符串格式时它仍然存在。