Serilog.Enrichers.ClientInfo 2.1.1

serilog-enrichers-clientinfo

使用客户端 IP、关联 ID 和 HTTP 请求头丰富日志。

安装 Serilog.Enrichers.ClientInfo NuGet 包

Install-Package Serilog.Enrichers.ClientInfo

或

dotnet add package Serilog.Enrichers.ClientInfo

将 enricher 应用于代码中的 LoggerConfiguration

Log.Logger = new LoggerConfiguration()
    .Enrich.WithClientIp()
    .Enrich.WithCorrelationId()
    .Enrich.WithRequestHeader("Header-Name1")
    // ...other configuration...
    .CreateLogger();

或 appsettings.json 文件中

{
  "Serilog": {
    "MinimumLevel": "Debug",
    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
    "Enrich": [
      "WithClientIp",
      "WithCorrelationId",
      {
          "Name": "WithRequestHeader",
          "Args": { "headerName": "User-Agent"}
      }
    ],
    "WriteTo": [
      { "Name": "Console" }
    ]
  }
}

ClientIp

ClientIp enricher 从 HttpContext.Connection.RemoteIpAddress 读取客户端 IP。由于版本 2.1，出于安全原因，它不再读取 x-forwarded-for 标头。要处理转发标头，配置 ForwardedHeadersOptions。如果您仍然想记录 x-forwarded-for，您可以使用 RequestHeader enricher。

Log.Logger = new LoggerConfiguration()
    .Enrich.WithClientIp()
    ...

或

{
  "Serilog": {
    "MinimumLevel": "Debug",
    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
    "Enrich": [
      {
        "Name": "WithClientIp"
      }
    ],
  }
}

CorrelationId

对于 CorrelationId enricher，您可以

• 配置标头名称，默认标头名称为 x-correlation-id
• 当请求头集合中不存在标头时，设置关联 ID 的值，默认值为 false

Log.Logger = new LoggerConfiguration()
    .Enrich.WithCorrelationId(headerName: "correlation-id", addValueIfHeaderAbsence: true)
    ...

或

{
  "Serilog": {
    "MinimumLevel": "Debug",
    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
    "Enrich": [
      {
        "Name": "WithCorrelationId",
        "Args": {
          "headerName": "correlation-id"
          "addValueIfHeaderAbsence": true
        }
      }
    ],
  }
}

RequestHeader

您可以使用多个 WithRequestHeader 来记录不同的请求头。 WithRequestHeader 接受两个参数；第一个参数 headerName 是要记录的标头名称，第二个参数是 propertyName，即日志属性名称。

Log.Logger = new LoggerConfiguration()
    .Enrich.WithRequestHeader(headerName: "header-name-1")
    .Enrich.WithRequestHeader(headerName: "header-name-2", propertyName: "SomeHeaderName")
    ...

或

{
  "Serilog": {
    "MinimumLevel": "Debug",
    "Using":  [ "Serilog.Enrichers.ClientInfo" ],
    "Enrich": [
      {
        "Name": "WithRequestHeader",
        "Args": {
          "headerName": "User-Agent"
        }
      },
      {
        "Name": "WithRequestHeader",
        "Args": {
          "headerName": "Connection"
        }
      },
      {
        "Name": "WithRequestHeader",
        "Args": {
          "headerName": "Content-Length",
          "propertyName": "RequestLength"
        }
      }
    ],
  }
}

注意

要将记录的标头包含在 OutputTemplate 中，如果未设置日志属性名称，应使用不带 - 的标头名称。例如，如果标头名称是 User-Agent，则应使用 UserAgent。

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Debug()
    .Enrich.WithRequestHeader("User-Agent")
    .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss}] {Level:u3} {UserAgent} {Message:lj}{NewLine}{Exception}")

安装到 ASP.NET Core Web 应用程序中

您需要注册 IHttpContextAccessor 单例，以便富集器可以访问请求的 HttpContext 以提取客户端 IP 和客户端代理。为了让此富集器按预期工作，您的 Startup 类应该包含以下内容。

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Serilog;

namespace MyWebApp
{
    public class Startup
    {
        public Startup()
        {
            Log.Logger = new LoggerConfiguration()
                .MinimumLevel.Debug()
                .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss}] {Level:u3} CLient IP: {ClientIp} Correlation Id: {CorrelationId} header-name: {headername} {Message:lj}{NewLine}{Exception}")
                .Enrich.WithClientIp()
                .Enrich.WithCorrelationId()
                .Enrich.WithRequestHeader("header-name")
                .Enrich.WithRequestHeader("another-header-name", "SomePropertyName")
                .CreateLogger();
        }

        // This method gets called by the runtime. Use this method to add services to the container.
        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
        public void ConfigureServices(IServiceCollection services)
        {
            // ...
            services.AddHttpContextAccessor();
            // ...
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
        {
            // ...
            loggerFactory.AddSerilog();
            // ...
        }
    }
}