NetCore remove TC.Active and fix NetCore Heartbeat

.publicApi/Microsoft.AI.WindowsServer.dll/net45/PublicAPI.Unshipped.txt

@@ -0,0 +1,4 @@
+Microsoft.ApplicationInsights.WindowsServer.AppServicesHeartbeatTelemetryModule.HeartbeatPropertyManager.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing.IHeartbeatPropertyManager
+Microsoft.ApplicationInsights.WindowsServer.AppServicesHeartbeatTelemetryModule.HeartbeatPropertyManager.set -> void
+Microsoft.ApplicationInsights.WindowsServer.AzureInstanceMetadataTelemetryModule.HeartbeatPropertyManager.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing.IHeartbeatPropertyManager
+Microsoft.ApplicationInsights.WindowsServer.AzureInstanceMetadataTelemetryModule.HeartbeatPropertyManager.set -> void

.publicApi/Microsoft.AI.WindowsServer.dll/netstandard2.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,4 @@
+Microsoft.ApplicationInsights.WindowsServer.AppServicesHeartbeatTelemetryModule.HeartbeatPropertyManager.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing.IHeartbeatPropertyManager
+Microsoft.ApplicationInsights.WindowsServer.AppServicesHeartbeatTelemetryModule.HeartbeatPropertyManager.set -> void
+Microsoft.ApplicationInsights.WindowsServer.AzureInstanceMetadataTelemetryModule.HeartbeatPropertyManager.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing.IHeartbeatPropertyManager
+Microsoft.ApplicationInsights.WindowsServer.AzureInstanceMetadataTelemetryModule.HeartbeatPropertyManager.set -> void

.publicApi/Microsoft.ApplicationInsights.AspNetCore.dll/net451/PublicAPI.Unshipped.txt

@@ -0,0 +1,4 @@
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.get -> bool
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.set -> void
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableActiveTelemetryConfigurationSetup.get -> bool
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableActiveTelemetryConfigurationSetup.set -> void

.publicApi/Microsoft.ApplicationInsights.AspNetCore.dll/net46/PublicAPI.Unshipped.txt

@@ -0,0 +1,4 @@
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.get -> bool
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.set -> void
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableActiveTelemetryConfigurationSetup.get -> bool
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableActiveTelemetryConfigurationSetup.set -> void

.publicApi/Microsoft.ApplicationInsights.AspNetCore.dll/net461/PublicAPI.Unshipped.txt

@@ -0,0 +1,4 @@
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.get -> bool
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.set -> void
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableActiveTelemetryConfigurationSetup.get -> bool
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableActiveTelemetryConfigurationSetup.set -> void

.publicApi/Microsoft.ApplicationInsights.AspNetCore.dll/netstandard2.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,4 @@
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.get -> bool
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.set -> void
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableActiveTelemetryConfigurationSetup.get -> bool
+Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions.EnableActiveTelemetryConfigurationSetup.set -> void

.publicApi/Microsoft.ApplicationInsights.WorkerService.dll/netstandard2.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,2 @@
+Microsoft.ApplicationInsights.WorkerService.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.get -> bool
+Microsoft.ApplicationInsights.WorkerService.ApplicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule.set -> void

NETCORE/src/Microsoft.ApplicationInsights.AspNetCore/Implementation/TelemetryConfigurationOptions.cs

@@ -3,6 +3,8 @@
     using System.Collections.Generic;
     using System.Diagnostics.CodeAnalysis;
     using System.Linq;
+
+    using Microsoft.ApplicationInsights.AspNetCore.Extensions;
     using Microsoft.ApplicationInsights.Extensibility;
     using Microsoft.Extensions.Options;
 
@@ -17,7 +19,8 @@ internal class TelemetryConfigurationOptions : IOptions<TelemetryConfiguration>
         /// Initializes a new instance of the <see cref="TelemetryConfigurationOptions"/> class.
         /// </summary>
         /// <param name="configureOptions">Options to be configured.</param>
-        public TelemetryConfigurationOptions(IEnumerable<IConfigureOptions<TelemetryConfiguration>> configureOptions)
+        /// <param name="applicationInsightsServiceOptions">User defined serviceOptions.</param>
+        public TelemetryConfigurationOptions(IEnumerable<IConfigureOptions<TelemetryConfiguration>> configureOptions, IOptions<ApplicationInsightsServiceOptions> applicationInsightsServiceOptions)
         {
             this.Value = TelemetryConfiguration.CreateDefault();
 
@@ -27,18 +30,21 @@ public TelemetryConfigurationOptions(IEnumerable<IConfigureOptions<TelemetryConf
                 c.Configure(this.Value);
             }
 
-            lock (LockObject)
+            if (applicationInsightsServiceOptions.Value.EnableActiveTelemetryConfigurationSetup)
             {
-                // workaround for Microsoft/ApplicationInsights-dotnet#613
-                // as we expect some customers to use TelemetryConfiguration.Active together with dependency injection
-                // we make sure it has been set up, it must be done only once even if there are multiple Web Hosts in the process
-                if (!IsActiveConfigured(this.Value.InstrumentationKey))
+                lock (LockObject)
                 {
-                    foreach (var c in configureOptionsArray)
+                    // workaround for Microsoft/ApplicationInsights-dotnet#613
+                    // as we expect some customers to use TelemetryConfiguration.Active together with dependency injection
+                    // we make sure it has been set up, it must be done only once even if there are multiple Web Hosts in the process
+                    if (!IsActiveConfigured(this.Value.InstrumentationKey))
                     {
+                        foreach (var c in configureOptionsArray)
+                        {
 #pragma warning disable CS0618 // This must be maintained for backwards compatibility.
-                        c.Configure(TelemetryConfiguration.Active); 
+                            c.Configure(TelemetryConfiguration.Active);
 #pragma warning restore CS0618
+                        }
                     }
                 }
             }

NETCORE/src/Shared/Extensions/ApplicationInsightsExtensions.cs

@@ -285,6 +285,26 @@ internal static void AddTelemetryConfiguration(
             }
         }
 
+        /// <summary>
+        /// The AddSingleton method will not check if a class has already been added as an ImplementationType. 
+        /// This extension method is to encapsulate those checks.
+        /// </summary>
+        /// <remarks>
+        /// Must check all three properties to avoid duplicates or null ref exceptions.
+        /// </remarks>
+        /// <typeparam name="TService">The type of the service to add.</typeparam>
+        /// <typeparam name="TImplementation">The type of the implementation to use.</typeparam>
+        /// <param name="services">The Microsoft.Extensions.DependencyInjection.IServiceCollection to add the service to.</param>
+        internal static void AddSingletonIfNotExists<TService, TImplementation>(this IServiceCollection services)
+            where TService : class
+            where TImplementation : class, TService
+        {
+            if (!services.Any(o => o.ImplementationFactory == null && typeof(TImplementation).IsAssignableFrom(o.ImplementationType ?? o.ImplementationInstance.GetType())))
+            {
+                services.AddSingleton<TService, TImplementation>();
+            }
+        }
+
         private static bool TryGetValue(this IConfiguration config, string primaryKey, out string value, string backupKey = null)
         {
             value = config[primaryKey];
@@ -316,9 +336,14 @@ private static void AddCommonInitializers(IServiceCollection services)
 
         private static void AddCommonTelemetryModules(IServiceCollection services)
         {
-            services.AddSingleton<ITelemetryModule, PerformanceCollectorModule>();
+            // Previously users were encouraged to manually add the DiagnosticsTelemetryModule.
+            services.AddSingletonIfNotExists<ITelemetryModule, DiagnosticsTelemetryModule>();
+
+            // These modules add properties to Heartbeat and expect the DiagnosticsTelemetryModule to be configured in DI.
             services.AddSingleton<ITelemetryModule, AppServicesHeartbeatTelemetryModule>();
             services.AddSingleton<ITelemetryModule, AzureInstanceMetadataTelemetryModule>();
+
+            services.AddSingleton<ITelemetryModule, PerformanceCollectorModule>();
             services.AddSingleton<ITelemetryModule, QuickPulseTelemetryModule>();
 
             AddAndConfigureDependencyTracking(services);

NETCORE/src/Shared/Extensions/ApplicationInsightsServiceOptions.cs

@@ -12,6 +12,10 @@ namespace Microsoft.ApplicationInsights.WorkerService
     /// </summary>
     public class ApplicationInsightsServiceOptions
     {
+        private bool enableAppServicesHeartbeatTelemetryModule = true;
+        private bool enableAzureInstanceMetadataTelemetryModule = true;
+        private bool enableHeartbeat = true;
+
         /// <summary>
         /// Gets or sets a value indicating whether QuickPulseTelemetryModule and QuickPulseTelemetryProcessor are registered with the configuration.
         /// Setting EnableQuickPulseMetricStream to <value>false</value>, will disable the default quick pulse metric stream. Defaults to <value>true</value>.
@@ -27,14 +31,24 @@ public class ApplicationInsightsServiceOptions
         /// <summary>
         /// Gets or sets a value indicating whether AppServicesHeartbeatTelemetryModule should be enabled.
         /// Defaults to <value>true</value>.
+        /// IMPORTANT: This setting will be disabled if <see cref="EnableDiagnosticsTelemetryModule"/> is set to false.
         /// </summary>
-        public bool EnableAppServicesHeartbeatTelemetryModule { get; set; } = true;
+        public bool EnableAppServicesHeartbeatTelemetryModule
+        {
+            get => this.enableAppServicesHeartbeatTelemetryModule && this.EnableDiagnosticsTelemetryModule;
+            set => this.enableAppServicesHeartbeatTelemetryModule = value;
+        }
 
         /// <summary>
         /// Gets or sets a value indicating whether AzureInstanceMetadataTelemetryModule should be enabled.
         /// Defaults to <value>true</value>.
+        /// IMPORTANT: This setting will be disabled if <see cref="EnableDiagnosticsTelemetryModule"/> is set to false.
         /// </summary>
-        public bool EnableAzureInstanceMetadataTelemetryModule { get; set; } = true;
+        public bool EnableAzureInstanceMetadataTelemetryModule 
+        { 
+            get => this.enableAzureInstanceMetadataTelemetryModule && this.EnableDiagnosticsTelemetryModule;
+            set => this.enableAzureInstanceMetadataTelemetryModule = value; 
+        }
 
         /// <summary>
         /// Gets or sets a value indicating whether DependencyTrackingTelemetryModule should be enabled.
@@ -88,8 +102,13 @@ public class ApplicationInsightsServiceOptions
 
         /// <summary>
         /// Gets or sets a value indicating whether heartbeats are enabled.
+        /// IMPORTANT: This setting will be disabled if <see cref="EnableDiagnosticsTelemetryModule"/> is set to false.
         /// </summary>
-        public bool EnableHeartbeat { get; set; } = true;
+        public bool EnableHeartbeat 
+        { 
+            get => this.enableHeartbeat && this.EnableDiagnosticsTelemetryModule; 
+            set => this.enableHeartbeat = value; 
+        }
 
         /// <summary>
         /// Gets or sets a value indicating whether AutoCollectedMetricExtractors are added or not.
@@ -116,11 +135,31 @@ public class ApplicationInsightsServiceOptions
         public bool EnableAuthenticationTrackingJavaScript { get; set; } = false;
 #endif
 
+        /// <summary>
+        /// Gets or sets a value indicating whether the <see cref="Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing.DiagnosticsTelemetryModule"/> should be enabled.
+        /// IMPORTANT: Disabling this will also disable the following settings:
+        /// <see cref="EnableHeartbeat"/>.
+        /// <see cref="EnableAzureInstanceMetadataTelemetryModule"/>.
+        /// <see cref="EnableAppServicesHeartbeatTelemetryModule"/>.
+        /// </summary>
+        public bool EnableDiagnosticsTelemetryModule { get; set; } = true;
+
         /// <summary>
         /// Gets <see cref="DependencyCollectionOptions"/> that allow to manage <see cref="DependencyTrackingTelemetryModule"/>.
         /// </summary>
         public DependencyCollectionOptions DependencyCollectionOptions { get; } = new DependencyCollectionOptions();
 
+#if AI_ASPNETCORE_WEB
+        /// <summary>
+        /// Gets or sets a value indicating whether TelemetryConfiguration.Active should be initialized.
+        /// Former versions of this library had a dependency on this static instance. 
+        /// This dependency has been removed and we no longer initialize this by default.
+        /// If users depended on this behavior you should enable this.
+        /// However, we recommend migrating away from using TelemetryConfiguration.Active in your projects.
+        /// </summary>
+        public bool EnableActiveTelemetryConfigurationSetup { get; set; } = false;
+#endif
+
         /// <summary>
         /// Copy the properties from this <see cref="ApplicationInsightsServiceOptions"/> to a target instance.
         /// </summary>
@@ -157,12 +196,15 @@ internal void CopyPropertiesTo(ApplicationInsightsServiceOptions target)
             target.EnableDependencyTrackingTelemetryModule = this.EnableDependencyTrackingTelemetryModule;
             target.EnableAppServicesHeartbeatTelemetryModule = this.EnableAppServicesHeartbeatTelemetryModule;
             target.EnableAzureInstanceMetadataTelemetryModule = this.EnableAzureInstanceMetadataTelemetryModule;
+            target.EnableDiagnosticsTelemetryModule = this.EnableDiagnosticsTelemetryModule;
+
 #if NETSTANDARD2_0
             target.EnableEventCounterCollectionModule = this.EnableEventCounterCollectionModule;
 #endif
 #if AI_ASPNETCORE_WEB
             target.EnableAuthenticationTrackingJavaScript = this.EnableAuthenticationTrackingJavaScript;
             target.EnableRequestTrackingTelemetryModule = this.EnableRequestTrackingTelemetryModule;
+            target.EnableActiveTelemetryConfigurationSetup = this.EnableActiveTelemetryConfigurationSetup;
 #endif
         }
     }

NETCORE/src/Shared/Implementation/TelemetryConfigurationOptionsSetup.cs

@@ -140,6 +140,13 @@ public void Configure(TelemetryConfiguration configuration)
                     configuration.TelemetryInitializers.Add(initializer);
                 }
 
+                // Find the DiagnosticsTelemetryModule, this is needed to initialize AzureInstanceMetadataTelemetryModule and AppServicesHeartbeatTelemetryModule.
+                DiagnosticsTelemetryModule diagModule =
+                    (this.applicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule && this.applicationInsightsServiceOptions.EnableHeartbeat)
+                    ? this.modules.OfType<DiagnosticsTelemetryModule>().FirstOrDefault()
+                    : null;
+
+                // Checks ApplicationInsightsServiceOptions and disable TelemetryModules if explicitly disabled.
                 foreach (ITelemetryModule module in this.modules)
                 {
                     // If any of the modules are disabled explicitly using aioptions,
@@ -149,6 +156,15 @@ public void Configure(TelemetryConfiguration configuration)
                     // So this approach of adding all modules to DI, but selectively
                     // disable those modules which user has disabled is chosen.
 
+                    if (module is DiagnosticsTelemetryModule)
+                    {
+                        if (!this.applicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule)
+                        {
+                            DisposeIfDisposable(module);
+                            continue;
+                        }
+                    }
+
                     // DependencyTrackingTelemetryModule
                     if (module is DependencyTrackingTelemetryModule)
                     {
@@ -194,23 +210,33 @@ public void Configure(TelemetryConfiguration configuration)
                     }
 
                     // AppServicesHeartbeatTelemetryModule
-                    if (module is AppServicesHeartbeatTelemetryModule)
+                    if (module is AppServicesHeartbeatTelemetryModule appServicesHeartbeatTelemetryModule)
                     {
                         if (!this.applicationInsightsServiceOptions.EnableAppServicesHeartbeatTelemetryModule)
                         {
                             DisposeIfDisposable(module);
                             continue;
                         }
+                        else if (diagModule != null)
+                        {
+                            // diagModule is set to Null above if (applicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule || this.applicationInsightsServiceOptions.EnableHeartbeat) == false.
+                            appServicesHeartbeatTelemetryModule.HeartbeatPropertyManager = diagModule;
+                        }
                     }
 
                     // AzureInstanceMetadataTelemetryModule
-                    if (module is AzureInstanceMetadataTelemetryModule)
+                    if (module is AzureInstanceMetadataTelemetryModule azureInstanceMetadataTelemetryModule)
                     {
                         if (!this.applicationInsightsServiceOptions.EnableAzureInstanceMetadataTelemetryModule)
                         {
                             DisposeIfDisposable(module);
                             continue;
                         }
+                        else if (diagModule != null)
+                        {
+                            // diagModule is set to Null above if (applicationInsightsServiceOptions.EnableDiagnosticsTelemetryModule || this.applicationInsightsServiceOptions.EnableHeartbeat) == false.
+                            azureInstanceMetadataTelemetryModule.HeartbeatPropertyManager = diagModule;
+                        }
                     }
 
                     // QuickPulseTelemetryModule
@@ -223,7 +249,14 @@ public void Configure(TelemetryConfiguration configuration)
                         }
                     }
 
-                    module.Initialize(configuration);
+                    try
+                    {
+                        module.Initialize(configuration);
+                    }
+                    catch (Exception ex)
+                    {
+                        throw new Exception($"Failed to initialize module '{module.GetType()}'", ex);
+                    }
                 }
 
                 foreach (ITelemetryProcessor processor in configuration.TelemetryProcessors)
@@ -320,7 +353,7 @@ private void DisableHeartBeatIfConfigured()
             // Disable heartbeat if user sets it (by default it is on)
             if (!this.applicationInsightsServiceOptions.EnableHeartbeat)
             {
-                foreach (var module in TelemetryModules.Instance.Modules)
+                foreach (var module in this.modules)
                 {
                     if (module is IHeartbeatPropertyManager hbeatMan)
                     {