feat: add option to clear existing logging providers in AddPowertoolsLogger method

Author: hjgraca

libraries/src/AWS.Lambda.Powertools.Logging/PowertoolsLoggingBuilderExtensions.cs

@@ -56,6 +56,7 @@ internal static PowertoolsLoggerConfiguration GetCurrentConfiguration()
     ///     Adds the Powertools logger to the logging builder with default configuration.
     /// </summary>
     /// <param name="builder">The logging builder to configure.</param>
+    /// <param name="clearExistingProviders">Opt-in to clear providers for Powertools-only output</param>
     /// <returns>The logging builder for further configuration.</returns>
     /// <remarks>
     ///     This method registers the Powertools logger with default settings. The logger will output 
@@ -78,8 +79,14 @@ internal static PowertoolsLoggerConfiguration GetCurrentConfiguration()
     ///     </code>
     /// </example>
     public static ILoggingBuilder AddPowertoolsLogger(
-        this ILoggingBuilder builder)
+        this ILoggingBuilder builder,
+        bool clearExistingProviders = false)
     {
+        if (clearExistingProviders)
+        {
+            builder.ClearProviders();
+        }
+        
         builder.AddConfiguration();
 
         // register standard logging services
@@ -118,6 +125,7 @@ public static ILoggingBuilder AddPowertoolsLogger(
     /// </summary>
     /// <param name="builder">The logging builder to configure.</param>
     /// <param name="configure"></param>
+    /// <param name="clearExistingProviders">Opt-in to clear providers for Powertools-only output</param>
     /// <returns>The logging builder for further configuration.</returns>
     /// <remarks>
     ///     This method registers the Powertools logger with default settings. The logger will output 
@@ -162,10 +170,11 @@ public static ILoggingBuilder AddPowertoolsLogger(
     /// </example>
     public static ILoggingBuilder AddPowertoolsLogger(
         this ILoggingBuilder builder,
-        Action<PowertoolsLoggerConfiguration> configure)
+        Action<PowertoolsLoggerConfiguration> configure,
+        bool clearExistingProviders = false)
     {
         // Add configuration
-        builder.AddPowertoolsLogger();
+        builder.AddPowertoolsLogger(clearExistingProviders);
 
         // Create initial configuration
         var options = new PowertoolsLoggerConfiguration();

libraries/tests/AWS.Lambda.Powertools.Logging.Tests/PowertoolsLoggerExtensionsTests.cs

@@ -0,0 +1,72 @@
+using System;
+using System.Linq;
+using AWS.Lambda.Powertools.Logging.Internal;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Xunit;
+
+namespace AWS.Lambda.Powertools.Logging.Tests;
+
+public class PowertoolsLoggerExtensionsTests
+{
+    [Fact]
+    public void AddPowertoolsLogger_WithClearExistingProviders_False_KeepsExistingProviders()
+    {
+        // Arrange
+        var serviceCollection = new ServiceCollection();
+        serviceCollection.AddLogging(builder =>
+        {
+            // Add a mock existing provider first
+            builder.Services.AddSingleton<ILoggerProvider, MockLoggerProvider>();
+        
+            // Act
+            builder.AddPowertoolsLogger(clearExistingProviders: false);
+        });
+
+        var serviceProvider = serviceCollection.BuildServiceProvider();
+        var loggerProviders = serviceProvider.GetServices<ILoggerProvider>();
+
+        // Assert
+        var collection = loggerProviders as ILoggerProvider[] ?? loggerProviders.ToArray();
+        Assert.Contains(collection, p => p is MockLoggerProvider);
+        Assert.Contains(collection, p => p is PowertoolsLoggerProvider);
+        Assert.True(collection.Count() >= 2); // Should have both providers
+    }
+
+    [Fact]
+    public void AddPowertoolsLogger_WithClearExistingProviders_True_RemovesExistingProviders()
+    {
+        // Arrange
+        var serviceCollection = new ServiceCollection();
+        serviceCollection.AddLogging(builder =>
+        {
+            // Add a mock existing provider first
+            builder.Services.AddSingleton<ILoggerProvider, MockLoggerProvider>();
+        
+            // Act
+            builder.AddPowertoolsLogger(clearExistingProviders: true);
+        });
+
+        var serviceProvider = serviceCollection.BuildServiceProvider();
+        var loggerProviders = serviceProvider.GetServices<ILoggerProvider>();
+
+        // Assert
+        var collection = loggerProviders as ILoggerProvider[] ?? loggerProviders.ToArray();
+        Assert.DoesNotContain(collection, p => p is MockLoggerProvider);
+        Assert.Contains(collection, p => p is PowertoolsLoggerProvider);
+        Assert.Single(collection); // Should only have Powertools provider
+    }
+    
+    private class MockLoggerProvider : ILoggerProvider
+    {
+        public ILogger CreateLogger(string categoryName) => new MockLogger();
+        public void Dispose() { }
+    }
+
+    private class MockLogger : ILogger
+    {
+        public IDisposable BeginScope<TState>(TState state) => null;
+        public bool IsEnabled(LogLevel logLevel) => true;
+        public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter) { }
+    }
+}