Emit {OriginalFormat} in HttpClient logger #6682
Merged
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
Adds the {OriginalFormat} property to the list of tags of HttpClient logs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds the {OriginalFormat} property to HttpClient logging to support structured logging scenarios. The change ensures that all HttpClient logs include the original format template as their last tag property.
- Updates the log message state construction to include the
{OriginalFormat}tag - Increases the minimal property count from 4 to 5 to accommodate the new tag
- Adds comprehensive test coverage to verify the presence of
{OriginalFormat}in all logging scenarios
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/Libraries/Microsoft.Extensions.Http.Diagnostics/Logging/Internal/Log.cs |
Adds {OriginalFormat} tag to all HttpClient log entries and updates property count |
test/Libraries/Microsoft.Extensions.Http.Diagnostics.Tests/Logging/HttpClientLoggerTest.cs |
Adds test verification for {OriginalFormat} presence in all test scenarios |
test/Libraries/Microsoft.Extensions.Http.Diagnostics.Tests/Logging/AcceptanceTests.cs |
Updates expected tag counts to account for the new {OriginalFormat} property |
Comments suppressed due to low confidence (1)
test/Libraries/Microsoft.Extensions.Http.Diagnostics.Tests/Logging/HttpClientLoggerTest.cs:1040
- The hardcoded expected value in the test doesn't match the actual
OriginalFormatValueconstant used in the production code. The production code usesHttpClientLoggingTagNames.Method,HttpClientLoggingTagNames.Host, andHttpClientLoggingTagNames.Pathwhich may have different values than the hardcoded string in the test.
Assert.Equal("{http.request.method} {server.address}/{url.path}", pair.Value);
dariusclay
approved these changes
Aug 5, 2025
mariamgerges
approved these changes
Aug 5, 2025
mobratil
approved these changes
Aug 5, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
Adds the
{OriginalFormat}property to the list of tags ofHttpClientlogs.Fixes #6364
Microsoft Reviewers: Open in CodeFlow