Make TelemetryConfiguration configurable in ApplicationInsightsLoggin…

…gBuilderExtensions (#2552) * Make TelemetryConfiguration configurable * public api * update test * update doc examples * fix doc * fix whitespace
microsoft · Mar 10, 2022 · ed0015a · ed0015a
1 parent c0b8fd8
commit ed0015a
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 20 deletions.
diff --git a/...crosoft.Extensions.Logging.ApplicationInsights.dll/netstandard2.0/PublicAPI.Unshipped.txt b/...crosoft.Extensions.Logging.ApplicationInsights.dll/netstandard2.0/PublicAPI.Unshipped.txt
@@ -0,0 +1 @@
+static Microsoft.Extensions.Logging.ApplicationInsightsLoggingBuilderExtensions.AddApplicationInsights(this Microsoft.Extensions.Logging.ILoggingBuilder builder, System.Action<Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration> configureTelemetryConfiguration, System.Action<Microsoft.Extensions.Logging.ApplicationInsights.ApplicationInsightsLoggerOptions> configureApplicationInsightsLoggerOptions) -> Microsoft.Extensions.Logging.ILoggingBuilder
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,7 @@
 # Changelog
 
 ## VNext
-
+- [LOGGING: Make TelemetryConfiguration configurable in ApplicationInsightsLoggingBuilderExtensions](https://github.com/microsoft/ApplicationInsights-dotnet/issues/1944)
 
 ## Version 2.21.0-beta1
 - [Support IPv6 in request headers](https://github.com/microsoft/ApplicationInsights-dotnet/issues/2521)

diff --git a/LOGGING/README.md b/LOGGING/README.md
@@ -29,7 +29,7 @@ Read more:
 - [Microsoft Docs: "Diagnose sudden changes in your app telemetry"](https://docs.microsoft.com/azure/application-insights/app-insights-analytics-diagnostics#trace)
 
 ## ILogger
-See [this](https://github.com/Microsoft/ApplicationInsights-dotnet-logging/tree/develop/src/ILogger/Readme.md).
+See [this](src/ILogger/Readme.md).
 
 ## NLog
 

diff --git a/LOGGING/src/ILogger/ApplicationInsightsLoggingBuilderExtensions.cs b/LOGGING/src/ILogger/ApplicationInsightsLoggingBuilderExtensions.cs
@@ -93,17 +93,26 @@ public static ILoggingBuilder AddApplicationInsights(
         /// <param name="builder">The <see cref="ILoggingBuilder"/> to use.</param>
         /// <param name="configureTelemetryConfiguration">Action to configure telemetry configuration.</param>
         /// <param name="configureApplicationInsightsLoggerOptions">Action to configure ApplicationInsights logger.</param>
-        private static ILoggingBuilder AddApplicationInsights(
+        public static ILoggingBuilder AddApplicationInsights(
             this ILoggingBuilder builder,
             Action<TelemetryConfiguration> configureTelemetryConfiguration,
             Action<ApplicationInsightsLoggerOptions> configureApplicationInsightsLoggerOptions)
         {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            if (configureTelemetryConfiguration == null)
+            {
+                throw new ArgumentNullException(nameof(configureTelemetryConfiguration));
+            }
+
             if (configureApplicationInsightsLoggerOptions == null)
             {
                 throw new ArgumentNullException(nameof(configureApplicationInsightsLoggerOptions));
             }
 
-            // Initialize IOptions<TelemetryConfiguration> user can keep on configuring it furthur if they want to.
             builder.Services.Configure<TelemetryConfiguration>(configureTelemetryConfiguration);
 
             builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, ApplicationInsightsLoggerProvider>());

diff --git a/LOGGING/src/ILogger/Readme.md b/LOGGING/src/ILogger/Readme.md
@@ -26,10 +26,12 @@ class Program
         // Add the logging pipelines to use. We are using Application Insights only here.
         services.AddLogging(loggingBuilder =>
         {
-	    // Optional: Apply filters to configure LogLevel Trace or above is sent to ApplicationInsights for all
-	    // categories.
-	    loggingBuilder.AddFilter<ApplicationInsightsLoggerProvider>("", LogLevel.Trace);
-            loggingBuilder.AddApplicationInsights("--YourAIKeyHere--");                
+            // Optional: Apply filters to configure LogLevel Trace or above is sent to ApplicationInsights for all categories.
+            loggingBuilder.AddFilter<ApplicationInsightsLoggerProvider>("", LogLevel.Trace);
+
+            loggingBuilder.AddApplicationInsights(
+                telemetryConfiguration => { telemetryConfiguration.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000"; },
+                applicationInsightsLoggerOptions => { });
         });
 
         // Build ServiceProvider.
@@ -68,15 +70,15 @@ public class Program
         .UseStartup<Startup>()                
         .ConfigureLogging(logging =>
         {                
-	    logging.AddApplicationInsights("ikeyhere");
+            loggingBuilder.AddApplicationInsights(
+                telemetryConfiguration => { telemetryConfiguration.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000"; },
+                applicationInsightsLoggerOptions => { });
 
-	    // Optional: Apply filters to configure LogLevel Trace or above is sent to
-	    // ApplicationInsights for all categories.
+            // Optional: Apply filters to configure LogLevel Trace or above is sent to ApplicationInsights for all categories.
             logging.AddFilter<ApplicationInsightsLoggerProvider>("", LogLevel.Trace);
 
-            // Additional filtering For category starting in "Microsoft",
-	    // only Warning or above will be sent to Application Insights.
-	    logging.AddFilter<ApplicationInsightsLoggerProvider>("Microsoft", LogLevel.Warning);
+            // Additional filtering For category starting in "Microsoft", only Warning or above will be sent to Application Insights.
+            logging.AddFilter<ApplicationInsightsLoggerProvider>("Microsoft", LogLevel.Warning);
         })
         .Build();
 }
@@ -138,13 +140,12 @@ public class ValuesController : ControllerBase
     [HttpGet]
     public ActionResult<IEnumerable<string>> Get()
     {
-        // All the following logs will be picked upby Application Insights.
-	// and all have ("MyKey", "MyValue") in Properties.
-	using (_logger.BeginScope(new Dictionary<string, object> { { "MyKey", "MyValue" } }))
+        // All the following logs will be picked upby Application Insights and all have ("MyKey", "MyValue") in Properties.
+	    using (_logger.BeginScope(new Dictionary<string, object> { { "MyKey", "MyValue" } }))
         {			
-	    _logger.LogInformation("This is an information trace..");
-	    _logger.LogWarning("This is a warning trace..");
-	    _logger.LogTrace("this is a Trace level message");
+	        _logger.LogInformation("This is an information trace..");
+	        _logger.LogWarning("This is a warning trace..");
+	        _logger.LogTrace("this is a Trace level message");
         }
 
         return new string[] { "value1", "value2" };

diff --git a/LOGGING/test/ILogger.Tests/ILoggerIntegrationTests.cs b/LOGGING/test/ILogger.Tests/ILoggerIntegrationTests.cs
@@ -314,6 +314,30 @@ public void ApplicationInsightsLoggerInstrumentationKeyIsSetCorrectly()
             Assert.AreEqual("TestAIKey", telemetryConfiguration.InstrumentationKey);
         }
 
+        /// <summary>
+        /// Test to ensure TelemetryConfiguration is set correctly.
+        /// </summary>
+        [TestMethod]
+        [TestCategory("ILogger")]
+        public void ApplicationInsightsLoggerTelemetryConfigurationIsSetCorrectly()
+        {
+            // Create DI container.
+            IServiceCollection services = new ServiceCollection();
+
+            services.AddLogging(loggingBuilder =>
+            {
+                loggingBuilder.AddApplicationInsights(
+                    telemetryConfiguration => { telemetryConfiguration.ConnectionString = "InstrumentationKey=TestAIKey"; },
+                    applicationInsightsLoggerOptions => { });
+            });
+
+            TelemetryConfiguration actualTelemetryConfiguration = services
+                .BuildServiceProvider()
+                .GetRequiredService<IOptions<TelemetryConfiguration>>().Value;
+
+            Assert.AreEqual("TestAIKey", actualTelemetryConfiguration.InstrumentationKey);
+        }
+
         /// <summary>
         /// Ensures that the default <see cref="ApplicationInsightsLoggerOptions"/> are as expected.
         /// </summary>