Elastic.CommonSchema.Serilog 8.11.1

Elastic Common Schema Serilog 文本格式化程序

此 ITextFormatter 实现将 Serilog 事件格式化为符合 Elastic Common Schema 规范的 JSON 表示形式。

软件包

.NET 程序集以 Elastic.CommonSchema.Serilog 包名发布到 NuGet。

如何启用

var logger = new LoggerConfiguration()
                .WriteTo.Console(new EcsTextFormatter())
                .CreateLogger();

在上面的代码片段中，new EcsTextFormatter() 启用文本格式化程序并指示 Serilog 将事件格式化为 JSON。上面的示例使用控制台接收器，但你可以使用任何你选择的接收器，也许可以考虑使用文件系统接收器以及 Elastic Filebeat 以实现耐用和可靠的摄取。

In ASP.NET（核心）应用程序

.UseSerilog((ctx, config) =>
{
  // Ensure HttpContextAccessor is accessible
  var httpAccessor = ctx.Configuration.Get<HttpContextAccessor>();

  config
    .ReadFrom.Configuration(ctx.Configuration)
    .Enrich.WithEcsHttpContext(httpAccessor)
    .WriteTo.Async(a => a.Console(new EcsTextFormatter()));
})

WithEcsHttpContext 确保日志将富含 HttpContext 数据。

以下是一个示例输出

{
  "@timestamp": "2019-11-22T14:59:02.5903135+11:00",
  "log.level": "Information",
  "message": "Info \"X\" 2.2",
  "ecs.version": "8.6.0",
  "log": { "logger": "Elastic.CommonSchema.Serilog.Tests.MessageTests" },
  "labels": {
    "MessageTemplate": "Info {ValueX} {SomeY}",
    "ValueX": "X",
    "ThreadName": ".NET Long Running Task"
  },
  "agent": {
    "type": "Elastic.CommonSchema.Serilog",
    "version": "1.6.0"
  },
  "event": {
    "created": "2019-11-22T14:59:02.5903135+11:00",
    "severity": 2,
    "timezone": "Romance Standard Time"
  },
  "host": {
    "os": {
      "full": "Microsoft Windows 10.0.19045",
      "platform": "Win32NT",
      "version": "10.0.19045.0"
    },
    "architecture": "X64",
    "hostname": "LOCALHOST",
    "name": "LOCALHOST"
  },
  "process": {
    "name": "dotnet",
    "pid": 1440,
    "thread.id": 15,
    "thread.name": ".NET Long Running Task",
    "title": ""
  },
  "server": { "user": { "name": "MyDomain\\MyUserName" } },
  "service": {
    "name": "Elastic.CommonSchema",
    "type": "dotnet",
    "version": "1.6.0"
  },
  "user": {
    "domain": "MyDomain",
    "name": "MyUserName"
  },
  "metadata": {
    "SomeY": 2.2
  }
}

配置

ECS Aware Message Templates

这个格式化程序还允许您使用遵循https://messagetemplates.org/格式的属性，直接从消息模板设置ECS字段。

可用的ECS消息模板属性列在LogTemplateProperties.*下，例如LogTemplateProperties.TraceId

Log.Information("The time is {TraceId}", "my-trace-id");

将覆盖结果ECS json文档中的trace.id。

版权和许可

本软件版权所有（c）2014-2020 Elasticsearch BV。

这是免费软件，根据以下许可证发布：Apache License Version 2.0。