EonaCat.Middleware.CorrelationId 1.0.0

Prefix Reserved
dotnet add package EonaCat.Middleware.CorrelationId --version 1.0.0
                    
NuGet\Install-Package EonaCat.Middleware.CorrelationId -Version 1.0.0
                    
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="EonaCat.Middleware.CorrelationId" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="EonaCat.Middleware.CorrelationId" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="EonaCat.Middleware.CorrelationId" />
                    
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 EonaCat.Middleware.CorrelationId --version 1.0.0
                    
#r "nuget: EonaCat.Middleware.CorrelationId, 1.0.0"
                    
#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 EonaCat.Middleware.CorrelationId@1.0.0
                    
#: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=EonaCat.Middleware.CorrelationId&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=EonaCat.Middleware.CorrelationId&version=1.0.0
                    
Install as a Cake Tool

EonaCat.Middleware.CorrelationId

Sets a CorrelationId for each request and response in ASP.NET Core. This is useful for tracking requests and responses in distributed systems. and to correlate logs across different services / microservices.

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // Register the LoggerScopedContext as a singleton, so it's shared across requests
        services.AddSingleton<LoggerScopedContext>();

        // Add other services like logging, MVC, etc.
        services.AddLogging();
        services.AddControllers();
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        // Use the CorrelationIdMiddleware in the pipeline
        app.UseMiddleware<CorrelationIdMiddleware>();

        app.UseRouting();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }
}

Usage example:

[ApiController]
[Route("api/[controller]")]
public class MyController : ControllerBase
{
    private readonly ILogger<MyController> _logger;
    private readonly LoggerScopedContext _loggerScopedContext;

    public MyController(ILogger<MyController> logger, LoggerScopedContext loggerScopedContext)
    {
        _logger = logger;
        _loggerScopedContext = loggerScopedContext;
    }

    [HttpGet]
    public IActionResult Get()
    {
        // Access the CorrelationId from the scoped context
        var correlationId = _loggerScopedContext.Get("CorrelationId");
        _logger.LogInformation("Handling request with CorrelationId: {CorrelationId}", correlationId);

        return Ok(new { CorrelationId = correlationId });
    }
}

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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. 
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.0.0 119 4/25/2025