ASP.NET Core correlation Id for distributed microservices.
Get Started
$ dotnet add package Elwark.CorrelationIdReadme
Elwark Correlation Id
A Correlation Id is a tool used in distributed systems to trace requests across multiple services. This specific library
offers a lightweight approach to implementing Correlation Ids. When enabled, it checks for the presence of a Correlation
Id in request headers and attaches it to the Correlation Context, which can then be used for logging and other purposes.
Additionally, this Correlation Id can also be attached to downstream HTTP calls made through an IHttpClientFactory.
However, it should be noted that this library may not be fully comprehensive and that built-in tracing options for .NET apps
may be more suitable for more extensive tracing needs.
Installation
You should install Elwark.CorrelationId from NuGet:
Install-Package Elwark.CorrelationId
This command from Package Manager Console will download and install CorrelationId and all required dependencies.
All stable and some pre-release packages are available on NuGet.
Quick Start
Register with DI
Inside ConfigureServices add the required correlation id services, with common defaults.
services.AddCorrelationId()
or you can define with options
services.AddCorrelationId(options =>
{
options.AddToLoggingScope = true;
options.EnforceHeader = true;
options.IgnoreRequestHeader = false;
options.IncludeInResponse = true;
options.RequestHeader = "X-Correlation-Id";
options.ResponseHeader = "X-Correlation-Id";
options.UpdateTraceIdentifier = false;
});
This registers a correlation id provider which generates new ids based on a random GUID.
Minimal API / MVC
You should install from NuGet:
