First Application Insights E2E test

Author: brettsam

src/WebJobs.Script/Config/ScriptSettingsManager.cs

@@ -68,6 +68,32 @@ public virtual string AzureWebsiteUniqueSlotName
             }
         }
 
+        public virtual string ApplicationInsightsInstrumentationKey
+        {
+            get => GetSettingFromCache(EnvironmentSettingNames.AppInsightsInstrumentationKey);
+            set => UpdateSettingInCache(EnvironmentSettingNames.AppInsightsInstrumentationKey, value);
+        }
+
+        private string GetSettingFromCache(string settingKey)
+        {
+            if (string.IsNullOrEmpty(settingKey))
+            {
+                throw new ArgumentNullException(nameof(settingKey));
+            }
+
+            return _settingsCache.GetOrAdd(settingKey, (key) => Utility.GetSettingFromConfigOrEnvironment(key));
+        }
+
+        private void UpdateSettingInCache(string settingKey, string settingValue)
+        {
+            if (string.IsNullOrEmpty(settingKey))
+            {
+                throw new ArgumentNullException(nameof(settingKey));
+            }
+
+            _settingsCache.AddOrUpdate(settingKey, settingValue, (a, b) => settingValue);
+        }
+
         public virtual void Reset()
         {
             _settingsCache.Clear();

src/WebJobs.Script/Description/FunctionInvokerBase.cs

@@ -15,7 +15,6 @@
 using Microsoft.Azure.WebJobs.Logging;
 using Microsoft.Azure.WebJobs.Script.Diagnostics;
 using Microsoft.Azure.WebJobs.Script.Eventing;
-using Microsoft.Azure.WebJobs.Script.IO;
 using Microsoft.CodeAnalysis;
 using Microsoft.Extensions.Logging;
 

src/WebJobs.Script/Diagnostics/DefaultLoggerFactoryBuilder.cs

@@ -3,10 +3,10 @@
 
 using Microsoft.Azure.WebJobs.Logging.ApplicationInsights;
 using Microsoft.Azure.WebJobs.Script.Config;
-using Microsoft.Azure.WebJobs.Script.Host;
+using Microsoft.Azure.WebJobs.Script.Diagnostics;
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.Azure.WebJobs.Script.Diagnostics
+namespace Microsoft.Azure.WebJobs.Script
 {
     /// <summary>
     /// Provides ways to plug into the ScriptHost ILoggerFactory initialization.
@@ -18,18 +18,17 @@ public class DefaultLoggerFactoryBuilder : ILoggerFactoryBuilder
         /// </summary>
         /// <param name="factory">The <see cref="ILoggerFactory"/>.</param>
         /// <param name="scriptConfig">The configuration.</param>
-        public void AddLoggerProviders(ILoggerFactory factory, ScriptHostConfiguration scriptConfig, ScriptSettingsManager settingsManager)
+        public virtual void AddLoggerProviders(ILoggerFactory factory, ScriptHostConfiguration scriptConfig, ScriptSettingsManager settingsManager)
         {
             IMetricsLogger metricsLogger = scriptConfig.HostConfig.GetService<IMetricsLogger>();
 
             // Automatically register App Insights if the key is present
-            string instrumentationKey = settingsManager?.GetSetting(ScriptConstants.AppInsightsInstrumentationKey);
-            if (!string.IsNullOrEmpty(instrumentationKey))
+            if (!string.IsNullOrEmpty(settingsManager?.ApplicationInsightsInstrumentationKey))
             {
                 metricsLogger?.LogEvent(MetricEventNames.ApplicationInsightsEnabled);
 
                 ITelemetryClientFactory clientFactory = scriptConfig.HostConfig.GetService<ITelemetryClientFactory>() ??
-                    new ScriptTelemetryClientFactory(instrumentationKey, scriptConfig.ApplicationInsightsSamplingSettings, scriptConfig.LogFilter.Filter);
+                    new ScriptTelemetryClientFactory(settingsManager.ApplicationInsightsInstrumentationKey, scriptConfig.ApplicationInsightsSamplingSettings, scriptConfig.LogFilter.Filter);
 
                 scriptConfig.HostConfig.LoggerFactory.AddApplicationInsights(clientFactory);
             }

src/WebJobs.Script/Diagnostics/FileLogger.cs

@@ -42,11 +42,12 @@ public bool IsEnabled(LogLevel logLevel)
 
         public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
         {
-            // We don't support any other type of state.
             IEnumerable<KeyValuePair<string, object>> properties = state as IEnumerable<KeyValuePair<string, object>>;
             string formattedMessage = formatter?.Invoke(state, exception);
 
-            if (string.IsNullOrEmpty(formattedMessage) || properties == null || !IsEnabled(logLevel) || IsFromTraceWriter(properties))
+            // If we have no structured data and no message, there's nothing to log
+            if ((string.IsNullOrEmpty(formattedMessage) && properties == null) ||
+                !IsEnabled(logLevel) || IsFromTraceWriter(properties))
             {
                 return;
             }
@@ -107,7 +108,14 @@ private static TraceLevel GetTraceLevel(LogLevel logLevel)
 
         private static bool IsFromTraceWriter(IEnumerable<KeyValuePair<string, object>> properties)
         {
-            return properties.Any(kvp => kvp.Key == ScriptConstants.TracePropertyIsUserTraceKey);
+            if (properties == null)
+            {
+                return false;
+            }
+            else
+            {
+                return properties.Any(kvp => string.Equals(kvp.Key, ScriptConstants.TracePropertyIsUserTraceKey, StringComparison.OrdinalIgnoreCase));
+            }
         }
     }
 }

src/WebJobs.Script/Diagnostics/ILoggerFactoryBuilder.cs

@@ -4,7 +4,7 @@
 using Microsoft.Azure.WebJobs.Script.Config;
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.Azure.WebJobs.Script.Diagnostics
+namespace Microsoft.Azure.WebJobs.Script
 {
     /// <summary>
     /// Provides ways to plug into the ScriptHost ILoggerFactory initialization.

src/WebJobs.Script/EnvironmentSettingNames.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
-using System;
-
 namespace Microsoft.Azure.WebJobs.Script
 {
     public static class EnvironmentSettingNames
@@ -23,5 +21,6 @@ public static class EnvironmentSettingNames
         public const string AzureWebJobsExtensionsPath = "AzureWebJobs_ExtensionsPath";
         public const string AzureWebsiteAppCountersName = "WEBSITE_COUNTERS_APP";
         public const string AzureWebJobsSecretStorageType = "AzureWebJobsSecretStorageType";
+        public const string AppInsightsInstrumentationKey = "APPINSIGHTS_INSTRUMENTATIONKEY";
     }
 }

src/WebJobs.Script/GlobalSuppressions.cs

@@ -187,5 +187,5 @@
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.FunctionTraceWriterFactory.#Create()")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.Description.FunctionInvokerBase.#.ctor(Microsoft.Azure.WebJobs.Script.ScriptHost,Microsoft.Azure.WebJobs.Script.Description.FunctionMetadata)")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.FunctionTraceWriterFactory.#CreateTraceWriter(Microsoft.Azure.WebJobs.Script.ScriptHostConfiguration,System.String)")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.Diagnostics.DefaultLoggerFactoryBuilder.#AddLoggerProviders(Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Azure.WebJobs.Script.ScriptHostConfiguration,Microsoft.Azure.WebJobs.Script.Config.ScriptSettingsManager)")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.ScriptHost.#ConfigureLoggerFactory(Microsoft.Azure.WebJobs.Script.ScriptHostConfiguration,Microsoft.Azure.WebJobs.Script.IFunctionTraceWriterFactory,Microsoft.Azure.WebJobs.Script.Config.ScriptSettingsManager,System.Func`1<System.Boolean>)")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.ScriptHost.#ConfigureLoggerFactory(Microsoft.Azure.WebJobs.Script.ScriptHostConfiguration,Microsoft.Azure.WebJobs.Script.IFunctionTraceWriterFactory,Microsoft.Azure.WebJobs.Script.Config.ScriptSettingsManager,System.Func`1<System.Boolean>)")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.DefaultLoggerFactoryBuilder.#AddLoggerProviders(Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Azure.WebJobs.Script.ScriptHostConfiguration,Microsoft.Azure.WebJobs.Script.Config.ScriptSettingsManager)")]

src/WebJobs.Script/Host/ScriptTelemetryClientFactory.cs

@@ -8,7 +8,7 @@
 using Microsoft.Azure.WebJobs.Logging.ApplicationInsights;
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.Azure.WebJobs.Script.Host
+namespace Microsoft.Azure.WebJobs.Script
 {
     /// <summary>
     /// Overrides the default client creation by adding a custom SdkVersion for backend tracking.

src/WebJobs.Script/ScriptConstants.cs

@@ -71,6 +71,5 @@ public static class ScriptConstants
         public const string SwaggerDocumentationKey = "swaggerdocumentationkey";
 
         public const int MaximumHostIdLength = 32;
-        public const string AppInsightsInstrumentationKey = "APPINSIGHTS_INSTRUMENTATIONKEY";
     }
 }

src/WebJobs.Script/Utility.cs

@@ -43,7 +43,9 @@ public static bool IsDynamic
         public static string GetSettingFromConfigOrEnvironment(string settingName)
         {
             string configValue = ConfigurationManager.AppSettings[settingName];
-            if (!string.IsNullOrEmpty(configValue))
+
+            // Empty strings are allowed. Null indicates that the setting was not found.
+            if (configValue != null)
             {
                 // config values take precedence over environment values
                 return configValue;