Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevejgordon/CorrelationId
An ASP.NET Core middleware component which synchronises a correlation ID for cross API request logging.
https://github.com/stevejgordon/CorrelationId
asp-net-core correlation microservices
Last synced: about 2 months ago
JSON representation
An ASP.NET Core middleware component which synchronises a correlation ID for cross API request logging.
- Host: GitHub
- URL: https://github.com/stevejgordon/CorrelationId
- Owner: stevejgordon
- License: mit
- Created: 2017-05-04T11:17:38.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T16:14:00.000Z (8 months ago)
- Last Synced: 2024-09-16T17:53:27.562Z (3 months ago)
- Topics: asp-net-core, correlation, microservices
- Language: C#
- Homepage:
- Size: 134 KB
- Stars: 557
- Watchers: 19
- Forks: 106
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
- awesome - stevejgordon/CorrelationId - An ASP.NET Core middleware component which synchronises a correlation ID for cross API request logging. (C\#)
README
# 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/) | [](https://www.nuget.org/packages/CorrelationId) | [](https://www.nuget.org/packages/CorrelationId) | [](https://www.nuget.org/packages/CorrelationId) | [](https://travis-ci.org/stevejgordon/CorrelationId) | [](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).