Add AzureClientsCore overload with enableLogging parameter (#30317)

* Add AzureClientsCore overload with enableLogging parameter

* Rename

Author: JoshLove-msft

sdk/extensions/Microsoft.Extensions.Azure/api/Microsoft.Extensions.Azure.netstandard2.0.cs

@@ -30,6 +30,7 @@ public static partial class AzureClientServiceCollectionExtensions
     {
         public static void AddAzureClients(this Microsoft.Extensions.DependencyInjection.IServiceCollection collection, System.Action<Microsoft.Extensions.Azure.AzureClientFactoryBuilder> configureClients) { }
         public static void AddAzureClientsCore(this Microsoft.Extensions.DependencyInjection.IServiceCollection collection) { }
+        public static void AddAzureClientsCore(this Microsoft.Extensions.DependencyInjection.IServiceCollection collection, bool enableLogForwarding) { }
     }
     public abstract partial class AzureComponentFactory
     {

sdk/extensions/Microsoft.Extensions.Azure/src/AzureClientServiceCollectionExtensions.cs

@@ -17,6 +17,7 @@ public static class AzureClientServiceCollectionExtensions
     {
         /// <summary>
         /// Adds the <see cref="IAzureClientFactory{TClient}"/> and related services to the <see cref="IServiceCollection"/>.
+        /// Azure SDK logging is enabled once the configured client is created.
         /// </summary>
         /// <param name="collection">The <see cref="IServiceCollection"/>.</param>
         /// <param name="configureClients">An <see cref="AzureClientFactoryBuilder"/> that can be used to configure the client.</param>
@@ -28,12 +29,36 @@ public static void AddAzureClients(this IServiceCollection collection, Action<Az
 
         /// <summary>
         /// Adds the minimum essential Azure SDK interop services like <see cref="AzureEventSourceLogForwarder"/> and <see cref="AzureComponentFactory"/> to the specified <see cref="IServiceCollection"/> without registering any client types.
+        /// Azure SDK log forwarding to to <see cref="ILogger"/> will not be enabled by default, but can be enabled by calling the <see cref="AzureEventSourceLogForwarder.Start"/> method.
+        /// Alternatively, you can use the <see cref="AddAzureClientsCore(Microsoft.Extensions.DependencyInjection.IServiceCollection, bool)"/> overload
+        /// and pass <value>true</value> to enable log forwarding.
         /// </summary>
         /// <param name="collection">The <see cref="IServiceCollection"/>.</param>
         public static void AddAzureClientsCore(this IServiceCollection collection)
+        {
+            collection.AddAzureClientsCore(false);
+        }
+
+        /// <summary>
+        /// Adds the minimum essential Azure SDK interop services like <see cref="AzureEventSourceLogForwarder"/> and <see cref="AzureComponentFactory"/> to the specified <see cref="IServiceCollection"/> without registering any client types.
+        /// </summary>
+        /// <param name="collection">The <see cref="IServiceCollection"/>.</param>
+        /// <param name="enableLogForwarding">Whether or not to enable Azure SDK log forwarding to <see cref="ILogger"/>. Even if this is set to <value>false</value>,
+        /// log forwarding can be enabled by calling the <see cref="AzureEventSourceLogForwarder.Start"/> method.</param>
+        public static void AddAzureClientsCore(this IServiceCollection collection, bool enableLogForwarding)
         {
             collection.AddOptions();
-            collection.TryAddSingleton<AzureEventSourceLogForwarder>();
+            collection.TryAddSingleton<AzureEventSourceLogForwarder>(provider =>
+            {
+                var loggerFactory = provider.GetRequiredService<ILoggerFactory>();
+                var forwarder = new AzureEventSourceLogForwarder(loggerFactory);
+                if (enableLogForwarding)
+                {
+                    forwarder.Start();
+                }
+
+                return forwarder;
+            });
             collection.TryAddSingleton<ILoggerFactory, NullLoggerFactory>();
             collection.TryAddSingleton<AzureComponentFactory, AzureComponentFactoryImpl>();
         }

sdk/extensions/Microsoft.Extensions.Azure/tests/AzureComponentFactoryTests.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System.Collections.Generic;
+using Azure.Core.Diagnostics;
 using Azure.Identity;
 using Microsoft.Extensions.Azure;
 using Microsoft.Extensions.Configuration;
@@ -131,6 +132,32 @@ public void GlobalOptionsAppliedToAzureComponentFactoryCreateClientOptions()
             Assert.AreEqual("AppId", options.Diagnostics.ApplicationId);
         }
 
+        [Test]
+        [TestCase(true)]
+        [TestCase(false)]
+        public void EnableLoggingRespectedWhenCallingAddAzureClientsCore(bool enableLogging)
+        {
+            var configuration = GetConfiguration(
+                new KeyValuePair<string, string>("TestClient:uri", "http://localhost/"));
+
+            var serviceCollection = new ServiceCollection();
+            serviceCollection.AddAzureClientsCore(enableLogging);
+
+            ServiceProvider provider = serviceCollection.BuildServiceProvider();
+            AzureComponentFactory factory = provider.GetService<AzureComponentFactory>();
+            TestClientWithCredentials client = (TestClientWithCredentials) factory.CreateClient(typeof(TestClientWithCredentials), configuration.GetSection("TestClient"), new EnvironmentCredential(), new TestClientOptions());
+
+            Assert.AreEqual("http://localhost/", client.Uri.ToString());
+            Assert.IsInstanceOf<EnvironmentCredential>(client.Credential);
+
+            AzureEventSourceLogForwarder forwarder = provider.GetService<AzureEventSourceLogForwarder>();
+            var listener = (AzureEventSourceListener) forwarder.GetType().GetField(
+                    "_listener",
+                    System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance)!
+                .GetValue(forwarder);
+            Assert.AreEqual(enableLogging, listener != null);
+        }
+
         private IConfiguration GetConfiguration(params KeyValuePair<string, string>[] items)
         {
             return new ConfigurationBuilder().AddInMemoryCollection(items).Build();