Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Powertools Logger v2 #832

Merged
merged 51 commits into from
Apr 8, 2025
Merged

chore: Powertools Logger v2 #832

merged 51 commits into from
Apr 8, 2025

Conversation

hjgraca
Copy link
Contributor

@hjgraca hjgraca commented Apr 7, 2025

Please provide the issue number

Issue number: #229 | #230 | #374 | #425 | #417 | #496 | #497 | #783

Summary

Changes

In this pull request we are moving Logger to v2 and added the following features:

  • ILogger support: Support for Microsoft.Extensions.Logging, this allows for more flexibility and testability
  • Log Buffering: support for buffering Logs
  • Message templating for objects and strings
  • Fix Top Level Statement lambdas to for the correct LogLevel in CloudWatch
  • Fix coldstart metric on provisioned concurrency lambdas
  • Prevent duplicate keys or override Powertools keys in the logger
  • Option to prevent Logger to change the case of nested objects
  • Improved testability
  • Documentation updates

Project Configuration:

  • Added a new project AOT-Function-ILogger to the solution file (AWS.Lambda.Powertools.sln). This includes adding the project reference and updating the build configurations. [1] [2] [3]
  • Removed the condition on the ProjectReference in AWS.Lambda.Powertools.BatchProcessing.csproj so that it always includes AWS.Lambda.Powertools.Common.csproj.

Environment Handling:

  • Added a new constant AWSInitializationTypeEnv in Constants.cs for handling AWS Lambda initialization type.
  • Enhanced IConsoleWrapper by removing the ReadLine method.
  • Added new properties to IPowertoolsConfigurations to track cold start and AWS initialization type.
  • Added a method to IPowertoolsEnvironment to set the AWS execution environment.
  • Introduced LambdaLifecycleTracker to track Lambda lifecycle state including cold starts.
  • Updated PowertoolsConfigurations to use PowertoolsEnvironment for environment variable handling and added support for cold start and initialization type. [1] [2] [3] [4] [5] [6] [7] [8] [9]
  • Enhanced PowertoolsEnvironment to set the AWS execution environment and parse assembly names. [1] [2]

User experience

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

Checklist

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

Is this a breaking change?

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.

hjgraca added 30 commits March 6, 2025 18:58
@hjgraca
refactor to support ILogger
01638c9
@hjgraca
refactor: change Logger class to static and enhance logging capabilities
477ad84
@hjgraca
feat(logging): add GetLogOutput method and CompositeJsonTypeInfoResol…
1e1716e 
…ver for enhanced logging capabilities
@hjgraca
refactor(logging): enhance IsEnabled method for improved log level ha…
a494c2b 
…ndling
@hjgraca
feat(logging): introduce custom logger output and enhance configurati…
8c03866 
…on options
@hjgraca
add log formatting
cfd2b28
@hjgraca
combine context, remove json key
70ba886
@hjgraca
add new LoggerFactory, add builder
1f5ea65
@hjgraca
refactor builder, configurations add timestamp format
d865fa2
@hjgraca
log formatter
c635752
@hjgraca
update to PowertoolsLoggerProvider
490a449
@hjgraca
log buffering 1
498f3e1
@hjgraca
buffer 2
7a28645
@hjgraca
buffer 3
9d48307
@hjgraca
buffer4
29690e2
@hjgraca
refactor: clean up whitespace and improve logger configuration handling
fc7b26b
@hjgraca
fix net8 serializer
b4741c0
@hjgraca
refactor: update log buffering options and improve serializer handling
2495098
@hjgraca
refactor configuration and create StringCaseExtensions
e497563
@hjgraca
checkpoint, some issues with buffer and loglevel
a742e5d
@hjgraca
fix buffering
e7dc704
@hjgraca
refactor: enhance logger configuration and output handling. Fix tests
c43c165
@hjgraca
tests green
2a8da60
@hjgraca
refactor: replace SystemWrapper with ConsoleWrapper in tests and upda…
bb9166d 
…te logging methods. revert systemwrapper, revert lambda.core to 2.5.0
@hjgraca
refactor: replace SystemWrapper with ConsoleWrapper in tests and upda…
6b8f843 
…te logging methods. revert systemwrapper, revert lambda.core to 2.5.0
@hjgraca
loggeroutput
34f2946
@hjgraca
refactor: improve logging buffer management and configuration handling
49ed301
@hjgraca
update and add tests. refactor logger formatter to support @ and non …
8abfa70 
…@ {}
@hjgraca
refactor: update parameter names and improve documentation in logging…
30672a7 
… configuration classes
@hjgraca
refactor: update logger factory and builder to support log output con…
4662622 
…figuration
hjgraca added 4 commits April 4, 2025 11:32
@hjgraca
refactor aspect to use MethodWrapper.FlushBufferOnUncaughtError feature
5bad7b6
@hjgraca
Logging Aspect with MethodWrapper. Log buffering with clear old invoc…
c77c8be 
…ations. ColdStart logic for provisioned-concurrency
@hjgraca
Remove duplicate keys.Add universalwrapper and attribute. Fix aspect …
8e86735 
…and common reference. Fix TypeInfoResolver
@hjgraca
Update all projects for new release target.
91195a4 
Bump logging package to 2.0.0-preview.1. Update documentation for v2.
Add integration tests.
@boring-cyborg boring-cyborg bot added area/common Core Powertools utility area/idempotency area/logging Core logging utility documentation Improvements or additions to documentation labels Apr 7, 2025
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Apr 7, 2025
@hjgraca hjgraca requested a review from leandrodamascena April 7, 2025 11:35
@codecov Codecov
Copy link

codecov bot commented Apr 7, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 75.66313% with 367 lines in your changes missing coverage. Please review.

Project coverage is 75.73%. Comparing base (8b6d925) to head (399ba36).
Report is 58 commits behind head on develop.

Files with missing lines Patch % Lines
...S.Lambda.Powertools.Logging/Logger.StandardLogs.cs 14.28% 72 Missing ⚠️
....Lambda.Powertools.Logging/Logger.ExtraKeysLogs.cs 17.85% 69 Missing ⚠️
...c/AWS.Lambda.Powertools.Logging/Logger.JsonLogs.cs 7.14% 39 Missing ⚠️
...da.Powertools.Logging/Internal/PowertoolsLogger.cs 86.42% 18 Missing and 12 partials ⚠️
...gging/Internal/Buffer/PowertoolsBufferingLogger.cs 74.11% 21 Missing and 1 partial ⚠️
...ambda.Powertools.Logging/Internal/LoggingAspect.cs 76.19% 16 Missing and 4 partials ⚠️
.../src/AWS.Lambda.Powertools.Logging/Logger.Scope.cs 56.25% 10 Missing and 4 partials ⚠️
...a.Powertools.Logging/PowertoolsLoggerExtensions.cs 55.55% 12 Missing ⚠️
...WS.Lambda.Powertools.Common/Core/ConsoleWrapper.cs 68.57% 9 Missing and 2 partials ⚠️
...da.Powertools.Logging/Internal/Buffer/LogBuffer.cs 77.77% 9 Missing and 1 partial ⚠️
... and 16 more
Additional details and impacted files 
@@             Coverage Diff             @@
##           develop     #832      +/-   ##
===========================================
+ Coverage    74.32%   75.73%   +1.40%     
===========================================
  Files          211      233      +22     
  Lines         8464     9391     +927     
  Branches       918     1027     +109     
===========================================
+ Hits          6291     7112     +821     
- Misses        1880     1960      +80     
- Partials       293      319      +26

☔ 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.

@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Apr 8, 2025

Quality Gate Passed Quality Gate passed

Issues
10 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

@hjgraca hjgraca merged commit b06fa34 into aws-powertools:develop Apr 8, 2025
9 checks passed
@hjgraca hjgraca deleted the feature/logger-ilogger-instance branch April 8, 2025 10:00
@github-actions github-actions bot added the internal Maintenance changes label Apr 8, 2025
@hjgraca hjgraca linked an issue Apr 8, 2025 that may be closed by this pull request
If extra keys has property "name", the logger name in the output is overwritten #229
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leandrodamascena leandrodamascena leandrodamascena approved these changes

Assignees
No one assigned
Labels
area/common Core Powertools utility area/idempotency area/logging Core logging utility documentation Improvements or additions to documentation internal Maintenance changes size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

If extra keys has property "name", the logger name in the output is overwritten
2 participants
@hjgraca @leandrodamascena