Add null check for UserName in logging context#37
Merged
marcominerva merged 2 commits intomasterfrom Oct 10, 2025
Merged
Conversation
Co-authored-by: marcominerva <3522534+marcominerva@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update logging mechanism to include UserName conditionally
Add null check for UserName in logging context
Oct 10, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the logging enricher by adding a null check for the UserName property before including it in the logging context. The change prevents cluttering logs with null username entries when user identity information is not available.
Key Changes
- Modified HttpContextLogEventEnricher to conditionally add UserName only when it exists and is not null/whitespace
- Follows the same conditional pattern already used for User-Agent header in the same class
- Improves log quality by reducing noise from null entries
marcominerva
approved these changes
Oct 10, 2025
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
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.
Problem
The logging enricher was unconditionally adding the
UserNameproperty to the logging context, even when the user identity was null or empty. This resulted in logs containingUserName: nullentries, which adds noise to the logs without providing meaningful information.Solution
Updated
HttpContextLogEventEnricher.csto only add theUserNameproperty to the logging context when it exists and is not null or whitespace. The implementation now:!string.IsNullOrWhiteSpace(userName)Before:
After:
This approach follows the same pattern already used for the
User-Agentheader in the same class, ensuring consistency in the codebase.Benefits
Fixes #[issue_number]
Original prompt
Fixes #36
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.