This repository contains .NET integrations that use the Elastic Common Schema (ECS), including popular .NET logging frameworks. Read the announcement post.
The Elastic Common Schema defines a common set of fields for ingesting data into Elasticsearch. A common schema helps you correlate data from sources like logs and metrics or IT operations analytics and security analytics. Further information on ECS can be found in the official Elastic documentation or github repository.
Contributions are welcome, please read our guidelines.
Version components: {major}.{minor}.{patch}
These libraries are not versioned according to SemVer principles. Backwards compatibility is only guaranteed within minor versions, since ECS only makes this guarantee. Patch releases of this library will not seek to introduce breaking changes, but will be used to address bug fixes within that minor version.
Each assembly release indicates the ECS version that it is compatible with (see releases), but typically the minor version number of the assembly correlates to the compatible version of ECS; for example; all of 1.4.0, 1.4.1, 1.4.2 and 1.4.3 are compatible with ECS version 1.4.0.
The assemblies are versioned using an assembly identity of major.minor.* as opposed to major.* as is common when following SemVer.
Official NuGet packages can be referenced from NuGet.org.
| Package Name | Purpose | Download |
|---|---|---|
Elastic.CommonSchema |
Foundational project that contains a full C# representation of ECS, used by the other integrations listed. |  |
Elastic.CommonSchema.Serilog |
Formats a Serilog log message into a JSON representation that can be indexed into Elasticsearch. |  |
Elastic.CommonSchema.NLog |
Formats an NLog message into a JSON representation that can be indexed into Elasticsearch. |  |
Elastic.CommonSchema.Log4net |
Formats a log4net message into a JSON representation that can be indexed into Elasticsearch. |  |
Elastic.Apm.SerilogEnricher |
Adds transaction id and trace id to every Serilog log message that is created during a transaction. This works in conjunction with the Elastic.CommonSchema.Serilog package and forms a solution to distributed tracing with Serilog. |  |
Elastic.Apm.NLog |
Introduces two special placeholder variables (ElasticApmTraceId and ElasticApmTransactionId) for use within your NLog templates. |  |
Elastic.CommonSchema.BenchmarkDotNetExporter |
An exporter for BenchmarkDotnet that can index benchmarking results directly into Elasticsearch, which can be helpful for detecting code-related performance problems over time. |  |
Foundational project that contains a full C# representation of ECS. Learn more...
Elastic Stack (ELK) logger provider for Microsoft.Extensions.Logging.
Writes direct to Elasticsearch using the Elastic Common Schema, with semantic logging of structured data from message and scope values.
This logger provider can be added directly to Microsoft.Extensions.Logging:
using Elastic.Extensions.Logging;
// ...
.ConfigureLogging((hostContext, loggingBuilder) =>
{
loggingBuilder.AddElasticsearch();
})Formats a Serilog event into a JSON representation that adheres to the Elastic Common Schema. Learn more...
var logger = new LoggerConfiguration()
.WriteTo.Console(new EcsTextFormatter())
.CreateLogger();Formats an NLog event into a JSON representation that adheres to the Elastic Common Schema. Learn more...
Layout.Register<EcsLayout>("EcsLayout"); // Register the ECS layout.
var config = new LoggingConfiguration();
var consoleTarget = new ConsoleTarget("console") { Layout = new EcsLayout() }; // Use the ECS layout.
config.AddRule(LogLevel.Debug, LogLevel.Fatal, consoleTarget);
LogManager.Configuration = config;
var logger = LogManager.GetCurrentClassLogger();Formats a log4net event into a JSON representation that adheres to the Elastic Common Schema. Learn more...
var hierarchy = (Hierarchy)LogManager.CreateRepository(Guid.NewGuid().ToString());
var appender = new ConsoleAppender { Layout = new EcsLayout() }; // Use the ECS layout.
hierarchy.Root.AddAppender(appender);
hierarchy.Root.Level = Level.All;
hierarchy.Configured = true;Adds transaction id and trace id to every Serilog log message that is created during a transaction. Learn more...
var logger = new LoggerConfiguration()
.Enrich.WithElasticApmCorrelationInfo()
.WriteTo.Console(outputTemplate: "[{ElasticApmTraceId} {ElasticApmTransactionId} {Message:lj} {NewLine}{Exception}")
.CreateLogger();When combined with Elastic.CommonSchema.Serilog the trace and transaction id will automatically appear in ECS as well.
var logger = new LoggerConfiguration()
.Enrich.WithElasticApmCorrelationInfo()
.WriteTo.Console(new EcsTextFormatter()) // APM information persisted in ECS as well
.CreateLogger();Introduce two special place holder variables (ElasticApmTraceId, ElasticApmTransactionId) easily into your NLog templates.
Learn more...
// Logged message will be in format of `trace-id|transation-id|InTransaction`
// or `||InTransaction` if the place holders are not available
var consoleTarget = new ConsoleTarget("console");
consoleTarget.Layout = "${ElasticApmTraceId}|${ElasticApmTransactionId}|${message}";
config.AddRule(LogLevel.Debug, LogLevel.Fatal, consoleTarget);
LogManager.Configuration = config;
var logger = LogManager.GetCurrentClassLogger();When using EcsLayout from Elastic.CommonSchema.NLog then trace and transaction id will automatically appear in ECS.
An exporter for BenchmarkDotnet that can index benchmarking result output directly into Elasticsearch. Learn more...
var options = new ElasticsearchBenchmarkExporterOptions(url)
{
GitBranch = "externally-provided-branch",
GitCommitMessage = "externally provided git commit message",
GitRepositoryIdentifier = "repository"
};
var exporter = new ElasticsearchBenchmarkExporter(options);
var config = CreateDefaultConfig().With(exporter);
BenchmarkRunner.Run(typeof(Md5VsSha256), config);This software is Copyright (c) 2014-2020 by Elasticsearch BV.
This is free software, licensed under: The Apache License Version 2.0.