SaanSoft.CorrelationId.Web 1.2.1

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package SaanSoft.CorrelationId.Web --version 1.2.1
                    


                    

                
NuGet\Install-Package SaanSoft.CorrelationId.Web -Version 1.2.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SaanSoft.CorrelationId.Web" Version="1.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SaanSoft.CorrelationId.Web" Version="1.2.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SaanSoft.CorrelationId.Web" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add SaanSoft.CorrelationId.Web --version 1.2.1
                    


                    

                
#r "nuget: SaanSoft.CorrelationId.Web, 1.2.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package SaanSoft.CorrelationId.Web@1.2.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=SaanSoft.CorrelationId.Web&version=1.2.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SaanSoft.CorrelationId.Web&version=1.2.1
                    


                            Install as a Cake Tool

SaanSoft.CorrelationId.Web

Use with SaanSoft.CorrelationId in web or api projects.

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.

Use WebCorrelationIdMiddleware to extract the CorrelationId from HTTP context and/or headers, and:

  • set the ICorrelationIdProvider to use that value
  • optionally set a response header with the CorrelationId (enabled by default)
  • optionally add the CorrelationId to ILogger.BeginScope so all structured logs have the CorrelationId on them (enabled by default)

Use WebCorrelationIdOptions.Evaluators to configure how the CorrelationId is extracted from the HTTP request. The first valid match is used. If no match is found, WebCorrelationIdMiddleware will generate a random string instead.

Use in your Api or Website

Prerequisite

Configure SaanSoft.CorrelationId.

Register middleware

Then in your Program.cs or Startup.cs add:

var app = builder.Build();

app.UseWebCorrelationIdMiddleware();
// OR
app.UseWebCorrelationIdMiddleware(new WebCorrelationIdOptions {
  ...
});
...

Evaluators

When registering WebCorrelationIdMiddleware, you can provide zero or more evaluators in the options.

The Evaluators are short functions which attempt to get the CorrelationId from HttpContext. Such as from a request header, or dotnet's built in Activity.Current.

Common evaluators can be found in SaanSoft.CorrelationId.Web.Evaluator, but you can provide your own if desired.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.2.2 107 9/14/2025
1.2.1 119 9/5/2025
1.2.0 143 9/3/2025

See https://github.com/saan800/saansoft-correlationid/releases for details.