Update TelemetryClient to enable tracking of dialog ('page') views

libraries/Microsoft.Bot.Builder.ApplicationInsights/BotTelemetryClient.cs

@@ -11,7 +11,7 @@ namespace Microsoft.Bot.Builder.ApplicationInsights
     /// <summary>
     /// A logging client for bot telemetry.
     /// </summary>
-    public class BotTelemetryClient : IBotTelemetryClient
+    public class BotTelemetryClient : IBotTelemetryClient, IBotPageViewTelemetryClient
     {
         private readonly TelemetryClient _telemetryClient;
 
@@ -168,6 +168,35 @@ public virtual void TrackTrace(string message, Severity severityLevel, IDictiona
             _telemetryClient.TrackTrace(telemetry);
         }
 
+        /// <summary>
+        /// Logs a dialog entry / as an Application Insights page view.
+        /// </summary>
+        /// <param name="dialogName">The name of the dialog to log the entry / start for.</param>
+        /// <param name="properties">Named string values you can use to search and classify events.</param>
+        /// <param name="metrics">Measurements associated with this event.</param>
+        public virtual void TrackPageView(string dialogName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
+        {
+            var telemetry = new PageViewTelemetry(dialogName);
+
+            if (properties != null)
+            {
+                foreach (var pair in properties)
+                {
+                    telemetry.Properties.Add(pair.Key, pair.Value);
+                }
+            }
+
+            if (metrics != null)
+            {
+                foreach (var pair in metrics)
+                {
+                    telemetry.Metrics.Add(pair.Key, pair.Value);
+                }
+            }
+
+            _telemetryClient.TrackPageView(telemetry);
+        }
+
         /// <summary>
         /// Flushes the in-memory buffer and any metrics being pre-aggregated.
         /// </summary>

libraries/Microsoft.Bot.Builder.Dialogs/ComponentDialog.cs

@@ -88,6 +88,8 @@ public override IBotTelemetryClient TelemetryClient
                 return await EndComponentAsync(outerDc, turnResult.Result, cancellationToken).ConfigureAwait(false);
             }
 
+            TelemetryClient.TrackDialogView(Id);
+
             // Just signal waiting
             return Dialog.EndOfTurn;
         }

libraries/Microsoft.Bot.Builder.Dialogs/WaterfallDialog.cs

@@ -77,6 +77,7 @@ public WaterfallDialog AddStep(WaterfallStep step)
                     { "InstanceId", instanceId },
                 };
             TelemetryClient.TrackEvent("WaterfallStart", properties);
+            TelemetryClient.TrackDialogView(Id);
 
             // Run first step
             return await RunStepAsync(dc, 0, DialogReason.BeginCalled, null, cancellationToken).ConfigureAwait(false);

libraries/Microsoft.Bot.Builder/IBotPageViewTelemetryClient.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+
+namespace Microsoft.Bot.Builder
+{
+    /// <summary>
+    /// Describes a logging client for bot telemetry.
+    /// </summary>
+    public interface IBotPageViewTelemetryClient
+    {
+        /// <summary>
+        /// Logs an Application Insights page view.
+        /// </summary>
+        /// <param name="dialogName">The name of the dialog to log the entry / start for.</param>
+        /// <param name="properties">Named string values you can use to search and classify events.</param>
+        /// <param name="metrics">Measurements associated with this event.</param>
+        void TrackPageView(string dialogName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null);
+    }
+}

libraries/Microsoft.Bot.Builder/IBotTelemetryClientExtensions.cs

@@ -0,0 +1,27 @@
+using System.Collections.Generic;
+
+namespace Microsoft.Bot.Builder
+{
+    public static class IBotTelemetryClientExtensions
+    {
+        /// <summary>
+        /// Log a DialogView using the TrackPageView method on the IBotTelemetryClient if IBotPageViewTelemetryClient has been implemented.
+        /// Alternatively log the information out via TrackTrace.
+        /// </summary>
+        /// <param name="telemetryClient">The TelemetryClient that implements IBotTelemetryClient.</param>
+        /// <param name="dialogName">The name of the dialog to log the entry / start for.</param>
+        /// <param name="properties">Named string values you can use to search and classify events.</param>
+        /// <param name="metrics">Measurements associated with this event.</param>
+        public static void TrackDialogView(this IBotTelemetryClient telemetryClient, string dialogName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
+        {
+            if (telemetryClient is IBotPageViewTelemetryClient pageViewClient)
+            {
+                pageViewClient.TrackPageView(dialogName, properties, metrics);
+            }
+            else
+            {
+                telemetryClient.TrackTrace($"Dialog View: {dialogName}", Severity.Information, properties);
+            }
+        }
+    }
+}

libraries/Microsoft.Bot.Builder/NullBotTelemetryClient.cs

@@ -6,7 +6,7 @@
 
 namespace Microsoft.Bot.Builder
 {
-    public class NullBotTelemetryClient : IBotTelemetryClient
+    public class NullBotTelemetryClient : IBotTelemetryClient, IBotPageViewTelemetryClient
     {
         public static IBotTelemetryClient Instance { get; } = new NullBotTelemetryClient();
 
@@ -33,5 +33,9 @@ public void TrackException(Exception exception, IDictionary<string, string> prop
         public void TrackTrace(string message, Severity severityLevel, IDictionary<string, string> properties)
         {
         }
+
+        public void TrackPageView(string dialogName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
+        {
+        }
     }
 }

libraries/integration/Microsoft.Bot.Builder.Integration.ApplicationInsights.Core/TelemetryBotIdInitializer.cs

@@ -38,7 +38,7 @@ public void Initialize(ITelemetry telemetry)
             if (items != null)
             {
                 if ((telemetry is RequestTelemetry || telemetry is EventTelemetry
-                    || telemetry is TraceTelemetry || telemetry is DependencyTelemetry)
+                    || telemetry is TraceTelemetry || telemetry is DependencyTelemetry || telemetry is PageViewTelemetry)
                     && items.ContainsKey(BotActivityKey))
                 {
                     if (items[BotActivityKey] is JObject body)

tests/Microsoft.Bot.Builder.ApplicationInsights.Tests/BotTelemetryClientTests.cs

@@ -128,6 +128,16 @@ public void TrackTraceTest()
                 _mockTelemetryChannel.Verify(tc => tc.Send(It.Is<TraceTelemetry>(t => t.SeverityLevel == SeverityLevel.Critical)));
                 _mockTelemetryChannel.Verify(tc => tc.Send(It.Is<TraceTelemetry>(t => t.Properties["foo"] == "bar")));
             }
+
+            [TestMethod]
+            public void TrackPageViewTest()
+            {
+                _botTelemetryClient.TrackDialogView("test", new Dictionary<string, string>() { { "hello", "value" } }, new Dictionary<string, double>() { { "metric", 0.6 } });
+
+                _mockTelemetryChannel.Verify(tc => tc.Send(It.Is<PageViewTelemetry>(t => t.Name == "test")));
+                _mockTelemetryChannel.Verify(tc => tc.Send(It.Is<PageViewTelemetry>(t => t.Properties["hello"] == "value")));
+                _mockTelemetryChannel.Verify(tc => tc.Send(It.Is<PageViewTelemetry>(t => t.Metrics["metric"] == 0.6)));
+            }
         }
     }
 }

tests/Microsoft.Bot.Builder.ApplicationInsights.Tests/MyBotTelemetryClient.cs

@@ -40,6 +40,11 @@ public override void TrackTrace(string message, Severity severityLevel, IDiction
             base.TrackTrace(message, severityLevel, properties);
         }
 
+        public override void TrackPageView(string name, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
+        {
+            base.TrackPageView(name, properties, metrics);
+        }
+
         public override void Flush()
         {
             base.Flush();

tests/Microsoft.Bot.Builder.ApplicationInsights.Tests/TelemetryWaterfallTests.cs

@@ -6,6 +6,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Bot.Builder.Adapters;
+using Microsoft.Bot.Builder.ApplicationInsights;
 using Microsoft.Bot.Builder.Dialogs;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Moq;

tests/Microsoft.Bot.Builder.Dialogs.Tests/ComponentDialogTests.cs

@@ -475,7 +475,7 @@ public CancelledComponentDialog(Dialog waterfallDialog)
             }
         }
 
-        private class MyBotTelemetryClient : IBotTelemetryClient
+        private class MyBotTelemetryClient : IBotTelemetryClient, IBotPageViewTelemetryClient
         {
             public MyBotTelemetryClient()
             {
@@ -496,6 +496,11 @@ public void TrackDependency(string dependencyTypeName, string target, string dep
                 throw new NotImplementedException();
             }
 
+            public void TrackPageView(string dialogName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
+            {
+                throw new NotImplementedException();
+            }
+
             public void TrackEvent(string eventName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
             {
                 throw new NotImplementedException();

tests/Microsoft.Bot.Builder.Dialogs.Tests/DialogSetTests.cs

@@ -130,7 +130,7 @@ public async Task DialogSet_HeterogeneousLoggers()
             await Task.CompletedTask;
         }
 
-        private class MyBotTelemetryClient : IBotTelemetryClient
+        private class MyBotTelemetryClient : IBotTelemetryClient, IBotPageViewTelemetryClient
         {
             public MyBotTelemetryClient()
             {
@@ -151,6 +151,11 @@ public void TrackDependency(string dependencyTypeName, string target, string dep
                 throw new NotImplementedException();
             }
 
+            public void TrackPageView(string dialogName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
+            {
+                throw new NotImplementedException();
+            }
+
             public void TrackEvent(string eventName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
             {
                 throw new NotImplementedException();