Anarchy.Toolkit.Infrastructure.CorrelationId
Part of Anarchy I/O Toolkit, a .NET developer platform · Pillar: Infrastructure · Layer: Infrastructure · Package catalog
Provider-neutral correlation and attempt ID propagation for ASP.NET Core services, workers and message consumers.
dotnet add package Anarchy.Toolkit.Infrastructure.CorrelationId
- Access IDs through the async-flowing
CorrelationContext. - Add
UseCorrelationId()to the ASP.NET Core pipeline; headers default toX-Correlation-IdandX-Attempt-Idand are configurable. - Correlation and attempt IDs are added to standard
ILoggerscopes and the currentActivityas tags, so logging and tracing providers can consume them without a Serilog dependency. - Use
CorrelationContext.BeginScope()in workers and message consumers to set IDs and open the same provider-neutral scope for an operation.
When to use it
Use correlation and attempt IDs to connect log events and traces from the same request or retry across service boundaries. The package provides inbound HTTP middleware and a helper for non-HTTP entry points; it does not automatically configure every outgoing HTTP client or message publisher to forward IDs.
How to use it
- Register
ModuleCorrelationIdwith the application’s configuration and environment. Pass aCorrelationIdOptionsfactory to customize header names, log property names or missing-header behavior. - Add
UseCorrelationId()early enough in the ASP.NET Core pipeline for later middleware and endpoints to see the context. - Use
CorrelationContext.BeginScope(logger, correlationId, attemptId)around worker or message-consumer work. It sets the async-flowing context, opens a standard logging scope and adds tags to the current activity.
The middleware and helper use both logging scopes and activity tags: scopes make the values available to any ILogger provider; tags make them available to tracing and OpenTelemetry pipelines. They do not use baggage, which would implicitly propagate values to downstream services. Use the optional Anarchy.Toolkit.Infrastructure.Telemetry.Serilog integration only when Serilog-specific event enrichment is needed.
The default behavior generates missing values. IgnoreIfMissing and ThrowIfMissing are available when the application instead wants to accept missing headers or reject them. Coordinate header names with upstream and downstream services.
See the observability guide and toolkit overview.
Releases
See the release notes for the complete release history.