Elastic.CommonSchema.Serilog 8.18.2

Prefix Reserved

.NET 8.0 .NET Standard 2.0 .NET Framework 4.6.2

dotnet add package Elastic.CommonSchema.Serilog --version 8.18.2

NuGet\Install-Package Elastic.CommonSchema.Serilog -Version 8.18.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Elastic.CommonSchema.Serilog" Version="8.18.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Elastic.CommonSchema.Serilog" Version="8.18.2" />
                    

                            Directory.Packages.props

<PackageReference Include="Elastic.CommonSchema.Serilog" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Elastic.CommonSchema.Serilog --version 8.18.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Elastic.CommonSchema.Serilog, 8.18.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#addin nuget:?package=Elastic.CommonSchema.Serilog&version=8.18.2
                    

                            Install as a Cake Addin

#tool nuget:?package=Elastic.CommonSchema.Serilog&version=8.18.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Elastic Common Schema Serilog Text Formatter

This ITextFormatter implementation formats a Serilog event into a JSON representation that adheres to the Elastic Common Schema specification.

Packages

The .NET assemblies are published to NuGet under the package name Elastic.CommonSchema.Serilog

How to Enable

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

In the code snippet above new EcsTextFormatter() enables the text formatter and instructs Serilog to format the event as JSON. The sample above uses the Console sink, but you are free to use any sink of your choice, perhaps consider using a filesystem sink and Elastic Filebeat for durable and reliable ingestion.

In ASP.NET (core) applications

.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()));
})

The WithEcsHttpContext ensures logs will be enriched with HttpContext data.

An example of the output is given below:

{
  "@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
  }
}

Configuration

Option	Description
`MapCurrentThead`	`true` map `ecs.process` by looking up the `Process` from the current thread
`MapHttpAdapter`	`null` a way to map `HttpContextAccessor` to ECS fields.
`LogEventsPropertiesToFilter`	A `Set<string>` of properties that should not be emitted as `labels.` or `metadata.`
`MapCustom`	A Func that allows you to mutate the EcsDocument before its fully converted.

ECS Aware Message Templates

This formatter also allows you to set ECS fields directly from the message template using properties that adhere to the https://messagetemplates.org/ format.

The available ECS message template properties are listed under LogTemplateProperties.* e.g LogTemplateProperties.TraceId

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

Will override trace.id on the resulting ECS json document.

Copyright and License

This is free software, licensed under: The Apache License Version 2.0.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 is compatible.
.NET Framework	net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETFramework 4.6.2
- Elastic.CommonSchema (>= 8.18.2)
- Serilog (>= 4.1.0)
.NETStandard 2.0
- Elastic.CommonSchema (>= 8.18.2)
- Serilog (>= 4.1.0)
.NETStandard 2.1
- Elastic.CommonSchema (>= 8.18.2)
- Serilog (>= 4.1.0)
net8.0
- Elastic.CommonSchema (>= 8.18.2)
- Serilog (>= 4.1.0)

NuGet packages (20)

Showing the top 5 NuGet packages that depend on Elastic.CommonSchema.Serilog:

Package	Downloads
Elastic.Serilog.Sinks Package Description	3.2M
Serilog.Sinks.Logz.Io Serilog event sink that sends logs to Logz.io.	1.7M
Sitko.Core.ElasticStack Sitko.Core is a set of libraries to help build .NET Core applications fast	290.3K
Elastic.Serilog.Enrichers.Web Serilog enricher for ASP.NET (Core) to inject more data in emitted Elastic Common Schema (ECS) documents.	254.8K
BioEngine.Extra.ElasticStack Package Description	168.2K

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Elastic.CommonSchema.Serilog:

Repository	Stars
jerrytang67/SoMall 社交电商商城开源项目.socail+mall即取名SoMall ,abp netcore 3.1 angular vue uni-app typescript docker mssql	540
damikun/trouble-training FullStack DDD/CQRS with GraphQL workshop including distributed tracing and monitoring. This shows the configuration from React frontend to .Net backend.	478
sitkoru/Sitko.Core Sitko.Core is a set of libraries to help build .NET Core applications fast	154

Version	Downloads	Last Updated
8.18.2	24,033	6/27/2025
8.18.1	92,282	5/28/2025
8.12.3	1,825,507	11/26/2024
8.12.2	500,951	10/22/2024
8.12.1	443,911	10/3/2024
8.12.0	79,491	9/26/2024
8.11.1	1,331,666	6/10/2024
8.11.0	847,358	4/10/2024
8.6.1	2,339,440	8/3/2023
8.6.0	471,063	5/9/2023
8.4.0-alpha4	12,238	3/28/2023
8.4.0-alpha3	567	3/15/2023
8.4.0-alpha2	539	3/1/2023
8.4.0-alpha1	1,019	2/20/2023
1.6.0-alpha1	90,973	6/2/2021
1.5.3	8,492,097	6/1/2021
1.5.1	1,586,298	6/3/2020
1.5.0	149,440	3/30/2020
1.4.4	1,670	3/25/2020
1.4.3	5,605	3/16/2020
1.4.2	26,763	3/6/2020
1.4.1	9,722	2/26/2020
1.4.0	32,891	1/29/2020
1.4.0-beta1	928	1/7/2020

https://github.com/elastic/ecs-dotnet/releases

Elastic.CommonSchema.Serilog 8.18.2

Elastic Common Schema Serilog Text Formatter

Packages

How to Enable

Configuration

ECS Aware Message Templates

Copyright and License

.NETFramework 4.6.2

.NETStandard 2.0

.NETStandard 2.1

net8.0

NuGet packages (20)

GitHub repositories (3)