SaanSoft.CorrelationId
1.2.2
dotnet add package SaanSoft.CorrelationId --version 1.2.2
NuGet\Install-Package SaanSoft.CorrelationId -Version 1.2.2
<PackageReference Include="SaanSoft.CorrelationId" Version="1.2.2" />
<PackageVersion Include="SaanSoft.CorrelationId" Version="1.2.2" />
<PackageReference Include="SaanSoft.CorrelationId" />
paket add SaanSoft.CorrelationId --version 1.2.2
#r "nuget: SaanSoft.CorrelationId, 1.2.2"
#:package SaanSoft.CorrelationId@1.2.2
#addin nuget:?package=SaanSoft.CorrelationId&version=1.2.2
#tool nuget:?package=SaanSoft.CorrelationId&version=1.2.2
SaanSoft.CorrelationId
In a distributed system it can be a challenge to trace HTTP requests and messages through multiple microservices.
A CorrelationId
(or some systems call it TraceId
) is metadata than can be used to bundle each logical transaction as it moves through multiple processors.
With this system, your client's requests are collected under one value for easier tracking and troubleshooting.
Register in IoC
ICorrelationIdProvider
should be registered at the request scope level, as it should be use the same object across all calls for a HTTP request or logical transaction.
IServiceCollection: Api and Web
For api and web projects, registering with the AddScoped
function is perfect, as it will create a new instance for each http request.
serviceCollection.AddScoped<ICorrelationIdProvider, CorrelationIdProvider>();
Usage
Pass ICorrelationIdProvider
into a class's constructor, then call correlationIdProvider.Get()
to retrieve the CorrelationId
for the current request.
Dependencies
CorrelationIdProvider
can be used by itself, and it will provide a unique string for each request.
However, you can also setup CorrelationIdProvider
to use values from other sources such as SaanSoft.CorrelationId.Web by using other dependencies and middleware.
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. 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 was computed. |
.NET Framework | net461 was computed. net462 was computed. 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. |
-
.NETStandard 2.0
- System.Text.RegularExpressions (>= 4.3.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on SaanSoft.CorrelationId:
Package | Downloads |
---|---|
SaanSoft.CorrelationId.Web
Middleware to extract the CorrelationId from Http Context and Headers and set in the ICorrelationidProvider. |
GitHub repositories
This package is not used by any popular GitHub repositories.
See https://github.com/saan800/saansoft-correlationid/releases for details.