feat(logging): Extract and store arbitrary values from the request

[gregsinclair42]

Please provide the issue number

Issue number: #816

Summary

Can now easily extract arbitrary values from the request and store as a logging key.

Changes

Please provide a summary of what's being changed

• Added a new parameter to LoggingAttribute called ExtractedKeyPaths
• Added a general private function CaptureKeyFromPath that works the same as CaptureCorrelationId did, but now it works for arbitrary keys and paths
• Updated a unit test

User experience

Please share what the user experience looks like before and after this change

Before: You would have to write custom code that executes on every request to extract the fields from the header for example, and save it in the log key. This is less convenient than adding it to the existing Logging attribute.

After: Simply update the parameter in the Logging attribute and it will do this work for you:

[Logging(ExtractedKeyPaths = [("Header/Device-Id", "DeviceId"), ("Header/User-Id", "UserId")]
void MyHandler(APIGatewayProxyRequest request, ILambdaContext context)
{
///
}

Checklist

Please leave checklist items unchecked if they do not apply to your change.

• Meets tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change? NO

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

Attention: Patch coverage is 96.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.12%. Comparing base (1a8c29c) to head (c5e62fa).
Report is 3 commits behind head on develop.

Files with missing lines	Patch %	Lines
...ambda.Powertools.Logging/Internal/LoggingAspect.cs	95.83%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #817      +/-   ##
===========================================
- Coverage    74.15%   74.12%   -0.03%     
===========================================
  Files          210      210              
  Lines         8411     8425      +14     
  Branches       909      911       +2     
===========================================
+ Hits          6237     6245       +8     
- Misses        1881     1886       +5     
- Partials       293      294       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.