CorrelationId 2.1.0
ASP.NET Core correlation ID middleware which synchronises the TraceIdentifier with a correlation ID header.
Install-Package CorrelationId -Version 2.1.0
dotnet add package CorrelationId --version 2.1.0
<PackageReference Include="CorrelationId" Version="2.1.0" />
paket add CorrelationId --version 2.1.0
Adds two additional options that can be set when adding the Correlation ID middleware:
UpdateTraceIdentifier - Controls whether the ASP.NET Core TraceIdentifier will be set to match the CorrelationId. The default value is true.
UseGuidForCorrelationId - Controls whether a GUID will be used in cases where no correlation ID is retrieved from the request header. When false the TraceIdentifier for the current request will be used. The default value is false.
Adds an additional property Header to the CorrelationContext so that the currently configured header name can be retrieved easily to then be set on downstream requests.
BREAKING CHANGE:
Unfortunately, despite this being a minor release a potential breaking change has slipped in. The Create method on the CorrelationContextFactory requires two arguments (previously one). If you are mocking or using this class directly then this change may affect you.
Adds two additional options that can be set when adding the Correlation ID middleware:
UpdateTraceIdentifier - Controls whether the ASP.NET Core TraceIdentifier will be set to match the CorrelationId. The default value is true.
UseGuidForCorrelationId - Controls whether a GUID will be used in cases where no correlation ID is retrieved from the request header. When false the TraceIdentifier for the current request will be used. The default value is false.
Adds an additional property Header to the CorrelationContext so that the currently configured header name can be retrieved easily to then be set on downstream requests.
BREAKING CHANGE:
Unfortunately, despite this being a minor release a potential breaking change has slipped in. The Create method on the CorrelationContextFactory requires two arguments (previously one). If you are mocking or using this class directly then this change may affect you.
Dependencies
-
.NETStandard 1.4
- Microsoft.AspNetCore.Http.Abstractions (>= 1.0.0)
- Microsoft.Extensions.Options (>= 1.0.0)
- NETStandard.Library (>= 1.6.1)
GitHub Usage
Showing the top 1 GitHub repositories that depend on CorrelationId:
| Repository | Stars | |
|---|---|---|
|
Dotnet-Boxed/Templates
.NET project templates with batteries included, providing the minimum amount of code required to get you going faster.
|