Adding EnableSqlCommandTextInstrumentation to ApplicationInsightsLogg…

…erOptions
Azure · Oct 18, 2020 · dc92938 · dc92938
1 parent b243ac0
commit dc92938
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 3 deletions.
diff --git a/src/Microsoft.Azure.WebJobs.Logging.ApplicationInsights/ApplicationInsightsLoggerOptions.cs b/src/Microsoft.Azure.WebJobs.Logging.ApplicationInsights/ApplicationInsightsLoggerOptions.cs
@@ -105,6 +105,9 @@ public TimeSpan QuickPulseInitializationDelay {
         /// </summary>
         public bool EnableDependencyTracking { get; set; } = true;
 
+
+        public bool EnableSqlCommandTextInstrumentation { get; set; } = false;
+
         /// <summary>
         /// Gets or sets HTTP request collection options. 
         /// </summary>

diff --git a/....Logging.ApplicationInsights/Extensions/ApplicationInsightsServiceCollectionExtensions.cs b/....Logging.ApplicationInsights/Extensions/ApplicationInsightsServiceCollectionExtensions.cs
@@ -108,9 +108,10 @@ public static IServiceCollection AddApplicationInsights(this IServiceCollection
             {
                 var options = provider.GetService<IOptions<ApplicationInsightsLoggerOptions>>().Value;
 
+                DependencyTrackingTelemetryModule dependencyCollector = null;
                 if (options.EnableDependencyTracking)
                 {
-                    var dependencyCollector = new DependencyTrackingTelemetryModule();
+                    dependencyCollector = new DependencyTrackingTelemetryModule();
                     var excludedDomains = dependencyCollector.ExcludeComponentCorrelationHttpHeadersOnDomains;
                     excludedDomains.Add("core.windows.net");
                     excludedDomains.Add("core.chinacloudapi.cn");
@@ -122,11 +123,15 @@ public static IServiceCollection AddApplicationInsights(this IServiceCollection
                     var includedActivities = dependencyCollector.IncludeDiagnosticSourceActivities;
                     includedActivities.Add("Microsoft.Azure.ServiceBus");
                     includedActivities.Add("Microsoft.Azure.EventHubs");
+                }
 
-                    return dependencyCollector;
+                if (options.EnableSqlCommandTextInstrumentation)
+                {
+                    dependencyCollector = dependencyCollector ?? new DependencyTrackingTelemetryModule();
+                    dependencyCollector.EnableSqlCommandTextInstrumentation = options.EnableSqlCommandTextInstrumentation;
                 }
 
-                return NullTelemetryModule.Instance;
+                return dependencyCollector as ITelemetryModule ?? NullTelemetryModule.Instance;
             });
 
             services.AddSingleton<ITelemetryModule>(provider =>

diff --git a/test/Microsoft.Azure.WebJobs.Host.UnitTests/Loggers/ApplicationInsightsConfigurationTests.cs b/test/Microsoft.Azure.WebJobs.Host.UnitTests/Loggers/ApplicationInsightsConfigurationTests.cs
@@ -404,6 +404,48 @@ public void DependencyInjectionConfiguration_DisablesDependencyTracking()
             }
         }
 
+        [Fact]
+        public void DependencyInjectionConfiguration_EnableSqlCommandTextInstrumentation()
+        {
+            using (var host = new HostBuilder()
+                .ConfigureLogging(b =>
+                {
+                    b.AddApplicationInsights(o =>
+                    {
+                        o.InstrumentationKey = "KI";
+                        o.EnableSqlCommandTextInstrumentation = true;
+                    });
+                })
+                .Build())
+            {
+                var modules = host.Services.GetServices<ITelemetryModule>();
+                var matchingModules = modules.Where(m => m is DependencyTrackingTelemetryModule);
+                Assert.True(matchingModules.Count() == 1);
+
+                var module = matchingModules.First() as DependencyTrackingTelemetryModule;
+                Assert.True(module.EnableSqlCommandTextInstrumentation);
+            }
+        }
+
+        [Fact]
+        public void DependencyInjectionConfiguration_SqlCommandTextInstrumentation_DisabledByDefault()
+        {
+            using (var host = new HostBuilder()
+                .ConfigureLogging(b =>
+                {
+                    b.AddApplicationInsights(o =>
+                    {
+                        o.InstrumentationKey = "KI";
+                        o.EnableDependencyTracking = false;
+                    });
+                })
+                .Build())
+            {
+                var modules = host.Services.GetServices<ITelemetryModule>();
+                Assert.True(modules.Count(m => m is DependencyTrackingTelemetryModule) == 0);
+            }
+        }
+
         [Fact]
         public void DependencyInjectionConfiguration_DisablesQuickPulseTelemetry()
         {