Fix race condition in generic diagnostic listener (#948)

Fix race condiftion in generic diagnostic listener

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Version 2.7.0-beta3
 - [Fix: SerializationException resolving Activity in cross app-domain calls](https://github.com/Microsoft/ApplicationInsights-dotnet-server/issues/613)
+- [Fix: Race condition in generic diagnostic source listener](https://github.com/Microsoft/ApplicationInsights-dotnet-server/pull/948)
 
 ## Version 2.7.0-beta1
 - [Add operation details for HTTP and SQL operation to the dependency telemetry.](https://github.com/Microsoft/ApplicationInsights-dotnet-server/issues/900)

Src/DependencyCollector/Shared.Tests/Implementation/TelemetryDiagnosticSourceListenerTests.cs

@@ -36,12 +36,25 @@ public void TestInitialize()
 
         #region Subscribtion tests
 
+        [TestMethod]
+        public void TelemetryDiagnosticSourceListenerOnCreatedListener()
+        {
+            DiagnosticListener listener = new DiagnosticListener("Test.A");
+            var inclusionList = new[] { "Test.A" }.ToList();
+            using (var dl = new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
+            {
+                dl.Subscribe();
+                Assert.IsTrue(listener.IsEnabled(), "There is a subscriber for a new diagnostic source");
+            }
+        }
+
         [TestMethod]
         public void TelemetryDiagnosticSourceListenerCapturesAllActivitiesByDefault()
         {
             var inclusionList = new[] { "Test.A" }.ToList();
-            using (new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
+            using (var dl = new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
             {
+                dl.Subscribe();
                 DiagnosticListener listener = new DiagnosticListener("Test.A");
                 Activity activity = new Activity("Test.A.Client.Monitoring");
 
@@ -74,8 +87,9 @@ public void TelemetryDiagnosticSourceListenerCapturesAllActivitiesByDefault()
         public void TelemetryDiagnosticSourceListenerIgnoresNotIncludedSources()
         {
             var inclusionList = new[] { "Test.B" }.ToList();
-            using (new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
+            using (var dl = new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
             {
+                dl.Subscribe();
                 // Diagnostic Source A is ignored
                 DiagnosticListener listenerA = new DiagnosticListener("Test.A");
                 Activity activityA = new Activity("Test.A.Client.Monitoring");
@@ -114,8 +128,9 @@ public void TelemetryDiagnosticSourceListenerIgnoresNotIncludedSources()
         public void TelemetryDiagnosticSourceListenerIgnoresNotIncludedActivities()
         {
             var inclusionList = new[] { "Test.A:Test.A.Client.Monitoring" }.ToList();
-            using (new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
+            using (var dl = new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
             {
+                dl.Subscribe();
                 // Diagnostic Source is not ignored
                 DiagnosticListener listener = new DiagnosticListener("Test.A");
 
@@ -167,8 +182,9 @@ public void TelemetryDiagnosticSourceListenerIgnoresNotIncludedActivities()
         public void TelemetryDiagnosticSourceListenerCollectsTelemetryFromRawActivity()
         {
             var inclusionList = new[] { "Test.A" }.ToList();
-            using (new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
+            using (var dl = new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
             {
+                dl.Subscribe();
                 DiagnosticListener listener = new DiagnosticListener("Test.A");
 
                 // generic example
@@ -231,6 +247,7 @@ public void TelemetryDiagnosticSourceListenerCallsCustomHandlersWhenEnabled()
             var inclusionList = new[] { "Test.A:Send", "Test.B" }.ToList();
             using (var telemetryListener = new TelemetryDiagnosticSourceListener(this.configuration, inclusionList))
             {
+                telemetryListener.Subscribe();
                 TestableEventHandler ahandler = new TestableEventHandler();
                 TestableEventHandler bhandler = new TestableEventHandler();
                 telemetryListener.RegisterHandler("Test.A", ahandler);

Src/DependencyCollector/Shared/DependencyTrackingTelemetryModule.cs

@@ -151,6 +151,7 @@ public void Initialize(TelemetryConfiguration configuration)
                                 this.telemetryDiagnosticSourceListener = new TelemetryDiagnosticSourceListener(configuration, this.IncludeDiagnosticSourceActivities);
                                 this.telemetryDiagnosticSourceListener.RegisterHandler(EventHubsDiagnosticsEventHandler.DiagnosticSourceName, new EventHubsDiagnosticsEventHandler(configuration));
                                 this.telemetryDiagnosticSourceListener.RegisterHandler(ServiceBusDiagnosticsEventHandler.DiagnosticSourceName, new ServiceBusDiagnosticsEventHandler(configuration));
+                                this.telemetryDiagnosticSourceListener.Subscribe();
                             }
 
                             this.sqlClientDiagnosticSourceListener = new SqlClientDiagnosticSourceListener(configuration);

Src/DependencyCollector/Shared/Implementation/DiagnosticSourceListenerBase.cs

@@ -16,13 +16,31 @@ internal abstract class DiagnosticSourceListenerBase<TContext> : IObserver<Diagn
         protected readonly TelemetryClient Client;
         protected readonly TelemetryConfiguration Configuration;
 
-        private readonly IDisposable listenerSubscription;
+        private IDisposable listenerSubscription;
         private List<IDisposable> individualSubscriptions;
 
+        /// <summary>
+        /// Creates DiagnosticSourceListenerBase. To finish the initialization and subscribe to all enabled sources,
+        /// call <see cref="Subscribe"/>
+        /// </summary>
+        /// <param name="configuration"><see cref="TelemetryConfiguration"/> instance.
+        /// The listener tracks dependency calls and uses configuration to construct <see cref="TelemetryClient"/></param>
         protected DiagnosticSourceListenerBase(TelemetryConfiguration configuration)
         {
             this.Configuration = configuration;
             this.Client = new TelemetryClient(configuration);
+        }
+
+        /// <summary>
+        /// Subscribes the listener to all enabled sources. This method must be called
+        /// to enable dependency calls collection.
+        /// </summary>
+        public void Subscribe()
+        {
+            if (this.listenerSubscription != null)
+            {
+                return;
+            }
 
             try
             {