CorrelationId - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #golang #machine-learning #linux #docker #java #windows #awesome-list #security #mcp #openai

CorrelationId

(★ 570)

An ASP.NET Core middleware component which synchronises a correlation ID for cross API request logging.

파일 탐색기

최종 버전 다운로드 (.zip)

- FUNDING.yml
- index.md
- releasenotes.md
- - CorrelationContext.cs
  - CorrelationContextAccessor.cs
  - CorrelationContextFactory.cs
  - CorrelationId.csproj
  - CorrelationIdExtensions.cs
  - CorrelationIdMiddleware.cs
  - CorrelationIdOptions.cs
- - CorrelationId.Tests.csproj
  - CorrelationIdMiddlewareTests.cs
.gitattributes
.gitignore
.travis.yml
azure-pipelines.yml
CorrelationId.sln
LICENSE.txt
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/stevejgordon/CorrelationId

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd CorrelationId

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. .NET

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
.NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.

dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

✅ dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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](https://devblogs.microsoft.com/aspnet/observability-asp-net-core-apps/#adding-tracing-to-a-net-core-application) for more complete and automated application tracing.**

## Release Notes

[Change history and release notes](https://stevejgordon.github.io/CorrelationId/releasenotes).

## Supported Runtimes
- .NET Standard 2.0+

| Package | NuGet Stable | NuGet Pre-release | Downloads | Travis CI | Azure Pipelines |
| ------- | ------------ | ----------------- | --------- | --------- | ----------------|
| [CorrelationId](https://www.nuget.org/packages/CorrelationId/) | [![NuGet](https://img.shields.io/nuget/v/CorrelationId.svg)](https://www.nuget.org/packages/CorrelationId) | [![NuGet](https://img.shields.io/nuget/vpre/CorrelationId.svg)](https://www.nuget.org/packages/CorrelationId) | [![Nuget](https://img.shields.io/nuget/dt/CorrelationId.svg)](https://www.nuget.org/packages/CorrelationId) | [![Build Status](https://travis-ci.org/stevejgordon/CorrelationId.svg?branch=master)](https://travis-ci.org/stevejgordon/CorrelationId) | [![Build Status](https://dev.azure.com/stevejgordon/CorrelationId/_apis/build/status/stevejgordon.CorrelationId?branchName=master)](https://dev.azure.com/stevejgordon/CorrelationId/_build/latest?definitionId=1&branchName=master) |

## Installation

You should install [CorrelationId from NuGet](https://www.nuget.org/packages/CorrelationId/):

```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](https://github.com/stevejgordon/CorrelationId/tree/master/samples/3.1/MvcSample) for example usage.

Full documentation can be found in the [wiki](https://github.com/stevejgordon/CorrelationId/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](https://github.com/aspnet/AspNetCore/issues/5144) 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](https://www.buymeacoffee.com/stevejgordon) or see the "Sponsor" link [at the top of the GitHub page](https://github.com/stevejgordon/CorrelationId).