Elastic.CommonSchema.Serilog
8.12.3
Prefix Reserved
dotnet add package Elastic.CommonSchema.Serilog --version 8.12.3
NuGet\Install-Package Elastic.CommonSchema.Serilog -Version 8.12.3
<PackageReference Include="Elastic.CommonSchema.Serilog" Version="8.12.3" />
paket add Elastic.CommonSchema.Serilog --version 8.12.3
#r "nuget: Elastic.CommonSchema.Serilog, 8.12.3"
// Install Elastic.CommonSchema.Serilog as a Cake Addin #addin nuget:?package=Elastic.CommonSchema.Serilog&version=8.12.3 // Install Elastic.CommonSchema.Serilog as a Cake Tool #tool nuget:?package=Elastic.CommonSchema.Serilog&version=8.12.3
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 software is Copyright (c) 2014-2020 by Elasticsearch BV.
This is free software, licensed under: The Apache License Version 2.0.
Product | Versions 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 was computed. 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. |
.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. |
-
.NETFramework 4.6.2
- Elastic.CommonSchema (>= 8.12.3)
- Serilog (>= 2.9.0)
-
.NETStandard 2.0
- Elastic.CommonSchema (>= 8.12.3)
- Serilog (>= 2.9.0)
-
.NETStandard 2.1
- Elastic.CommonSchema (>= 8.12.3)
- Serilog (>= 2.9.0)
NuGet packages (20)
Showing the top 5 NuGet packages that depend on Elastic.CommonSchema.Serilog:
Package | Downloads |
---|---|
Serilog.Sinks.Logz.Io
Serilog event sink that sends logs to Logz.io. |
|
Elastic.Serilog.Sinks
Package Description |
|
Sitko.Core.ElasticStack
Sitko.Core is a set of libraries to help build .NET Core applications fast |
|
BioEngine.Extra.ElasticStack
Package Description |
|
Elastic.Serilog.Enrichers.Web
Serilog enricher for ASP.NET (Core) to inject more data in emitted Elastic Common Schema (ECS) documents. |
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
|
|
damikun/trouble-training
FullStack DDD/CQRS with GraphQL workshop including distributed tracing and monitoring. This shows the configuration from React frontend to .Net backend.
|
|
sitkoru/Sitko.Core
Sitko.Core is a set of libraries to help build .NET Core applications fast
|
Version | Downloads | Last updated |
---|---|---|
8.12.3 | 58,543 | 11/26/2024 |
8.12.2 | 152,638 | 10/22/2024 |
8.12.1 | 212,064 | 10/3/2024 |
8.12.0 | 39,580 | 9/26/2024 |
8.11.1 | 732,283 | 6/10/2024 |
8.11.0 | 568,507 | 4/10/2024 |
8.6.1 | 1,789,447 | 8/3/2023 |
8.6.0 | 395,788 | 5/9/2023 |
8.4.0-alpha4 | 10,770 | 3/28/2023 |
8.4.0-alpha3 | 528 | 3/15/2023 |
8.4.0-alpha2 | 503 | 3/1/2023 |
8.4.0-alpha1 | 974 | 2/20/2023 |
1.6.0-alpha1 | 86,372 | 6/2/2021 |
1.5.3 | 7,761,069 | 6/1/2021 |
1.5.1 | 1,528,251 | 6/3/2020 |
1.5.0 | 148,409 | 3/30/2020 |
1.4.4 | 1,587 | 3/25/2020 |
1.4.3 | 5,527 | 3/16/2020 |
1.4.2 | 25,962 | 3/6/2020 |
1.4.1 | 9,641 | 2/26/2020 |
1.4.0 | 15,797 | 1/29/2020 |
1.4.0-beta1 | 855 | 1/7/2020 |