Add UserClaims enricher to log authenticated user claim values #63
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.
Summary
This PR implements a new
UserClaimsEnricher
for Serilog that allows logging of specific user claim values from authenticated users. This enhancement provides better traceability by capturing relevant user-specific information in logs.Changes
New Enricher
UserClaimsEnricher
: A new enricher that logs configurable user claim valuesparams string[] claimNames
null
values instead of throwing errors or skippingHttpContext.Items
for optimal performanceExtension Method
WithUserClaims()
extension method toClientInfoLoggerConfigurationExtensions
appsettings.json
configurationUsage Examples
Programmatic configuration:
Configuration via appsettings.json:
Features
✅ Configurable Claims: Specify which claims to log by passing claim names as parameters
✅ Null-Safe: Missing claims are logged as
null
rather than causing errors✅ Authentication-Aware: Only enriches logs for authenticated users
✅ Performance Optimized: Claims are cached per request to avoid redundant lookups
✅ Consistent API: Follows the same patterns as existing enrichers in the library
Testing
Added comprehensive test coverage with 10 new test cases covering:
All 55 tests pass (45 existing + 10 new).
Documentation
Updated README.md with:
Fixes #[issue_number]
Original prompt
Fixes #62
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.