百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
C

CorrelationId

> 编程语言
开源

一个 ASP.NET Core 中间件组件,用于同步跨 API 请求日志的关联 ID。

570 stars0 点赞0 次浏览
访问官网GitHub

工具介绍

一个 ASP.NET Core 中间件组件,用于同步跨 API 请求日志的关联 ID。

Correlation ID

Correlations IDs are used in distributed applications to trace requests across multiple services. This library and package provides a lightweight correlation ID approach. When enabled, request headers are checked for a correlation ID from the consumer. If found, this correlation ID is attached to the Correlation Context which can be used to access the current correlation ID where it is required for logging etc.

Optionally, this correlation ID can be attached to downstream HTTP calls made via a HttpClient instance created by the IHttpClientFactory.

NOTE: While I plan to add a few more features to this library, I believe it is close to feature complete for the scenario it was designed for. I recommend looking at built-in tracing for .NET apps for more complete and automated application tracing.

Release Notes

Change history and release notes.

Supported Runtimes

  • .NET Standard 2.0+
Package NuGet Stable NuGet Pre-release Downloads Travis CI Azure Pipelines
CorrelationId

Installation

You should install CorrelationId from NuGet:

ps
Install-Package 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.

csharp
services.AddDefaultCorrelationId

This registers a correlation ID provider which generates new IDs based on a random GUID.

Add the middleware

Register the middleware into the pipeline. This should occur before any downstream middleware which requires the correlation ID. Normally this will be registered very early in the middleware pipeline.

csharp
app.UseCorrelationId();

Where you need to access the correlation ID, you may request the ICorrelationContextAccessor from DI.

csharp
public class TransientClass
{
   private readonly ICorrelationContextAccessor _correlationContext;

   public TransientClass(ICorrelationContextAccessor correlationContext)
   {
	  _correlationContext = correlationContext;
   }

   ...
}

See the sample app for example usage.

Full documentation can be found in the wiki.

Known Issue with ASP.NET Core 2.2.0

It appears that a regression in the code for ASP.NET Core 2.2.0 means that setting the TraceIdentifier on the context via middleware results in the context becoming null when accessed further down in the pipeline. A fix is was released in 2.2.2.

A workaround at this time is to disable the behaviour of updating the TraceIdentifier using the options when adding the middleware.

Support

If this library has helped you, feel free to buy me a coffee or see the "Sponsor" link at the top of the GitHub page.

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

C#asp-net-corecorrelationmicroservices

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言