chore: Add automatic registration of standard logging services and ILogger

[hjgraca]

Please provide the issue number

Issue number: #937

Summary

Changes

This pull request enhances the AddPowertoolsLogger method in AWS.Lambda.Powertools.Logging to improve service registration and logging functionality. The most notable changes include adding standard logging services and automatically registering the ILogger interface.

Improvements to service registration:

• libraries/src/AWS.Lambda.Powertools.Logging/PowertoolsLoggingBuilderExtensions.cs: Added builder.Services.AddLogging() to register standard logging services.

Enhancements to logging functionality:

• libraries/src/AWS.Lambda.Powertools.Logging/PowertoolsLoggingBuilderExtensions.cs: Automatically registered the ILogger interface by adding a singleton service that retrieves and creates a PowertoolsLogger instance from the ILoggerFactory.

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.

• 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?

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.38%. Comparing base (3cd704a) to head (cf5f8bd).
Report is 6 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #938      +/-   ##
===========================================
+ Coverage    77.31%   77.38%   +0.06%     
===========================================
  Files          271      271              
  Lines        10864    10870       +6     
  Branches      1280     1281       +1     
===========================================
+ Hits          8400     8412      +12     
+ Misses        2046     2041       -5     
+ Partials       418      417       -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.

[j-d-ha]

Hi @hjgraca! I tried adding the temporary fix you mentioned here and it had a weird side effect. It looks like log messages are being output twice, once as a standard log message and once as a structured log message (as expected):

For this PR, I think the logging provider that you added on 86 might need to be removed later to avoid this issue.

It's also possible that the temp fix I tried works differently and as such, this is a non-issue 😄.

[hjgraca]

Hi @hjgraca! I tried adding the temporary fix you mentioned here and it had a weird side effect. It looks like log messages are being output twice, once as a standard log message and once as a structured log message (as expected):

For this PR, I think the logging provider that you added on 86 might need to be removed later to avoid this issue.

It's also possible that the temp fix I tried works differently and as such, this is a non-issue 😄.

Ah yes, it needs to clear providers, good catch

builder.Logging.ClearProviders();

[hjgraca]

To prevent multiple logger providers the user can do it manually

builder.Logging.ClearProviders();

or with the new method override ClearExistingProviders

    builder.Logging.AddPowertoolsLogger(config =>
        {
        config.Service = "TestService";
        config.LoggerOutputCase = LoggerOutputCase.PascalCase;
        }, clearExistingProviders: true);

[j-d-ha]

To prevent multiple logger providers the user can do it manually

builder.Logging.ClearProviders();

or with the new method override ClearExistingProviders

    builder.Logging.AddPowertoolsLogger(config =>
        {
        config.Service = "TestService";
        config.LoggerOutputCase = LoggerOutputCase.PascalCase;
        }, clearExistingProviders: true);

I ran a test with this, and it works. Thank you!

[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