Add correlation ID retrieval and related tests. #51 #58
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated `README.md` with instructions for using the `GetCorrelationId()` extension method. - Introduced `CorrelationIdValueKey` constant in `Constants.cs`. - Enhanced `CorrelationIdEnricher` to store the correlation ID in the HTTP context. - Added `GetCorrelationId()` extension method in `HttpContextExtensions.cs`. - Expanded tests in `CorrelationIdEnricherTests.cs` to cover various scenarios for correlation ID retrieval.
There was a problem hiding this comment.
Pull Request Overview
This PR adds functionality to retrieve correlation IDs from HTTP context and includes comprehensive test coverage. The main purpose is to provide a clean API for accessing correlation IDs that were previously only available through log enrichment.
- Introduced a new
GetCorrelationId()extension method for HttpContext - Enhanced the CorrelationIdEnricher to store correlation ID values in HTTP context items
- Added extensive test coverage for various correlation ID retrieval scenarios
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Serilog.Enrichers.ClientInfo/Constants.cs | Added constant for correlation ID value storage key |
| src/Serilog.Enrichers.ClientInfo/Enrichers/CorrelationIdEnricher.cs | Enhanced to store correlation ID string values in HTTP context |
| src/Serilog.Enrichers.ClientInfo/Extensions/HttpContextExtensions.cs | New extension method for retrieving correlation IDs |
| test/Serilog.Enrichers.ClientInfo.Tests/CorrelationIdEnricherTests.cs | Comprehensive test coverage for correlation ID retrieval scenarios |
| README.md | Documentation for using the GetCorrelationId() extension method |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…ests.cs Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README.mdwith instructions for using theGetCorrelationId()extension method.CorrelationIdValueKeyconstant inConstants.cs.CorrelationIdEnricherto store the correlation ID in the HTTP context.GetCorrelationId()extension method inHttpContextExtensions.cs.CorrelationIdEnricherTests.csto cover various scenarios for correlation ID retrieval.