On the fly docs - add telemetry regarding documentation comments

src/EditorFeatures/Core.Wpf/QuickInfo/OnTheFlyDocsView.xaml.cs

@@ -206,8 +206,15 @@ public void RequestResults()
         Logger.Log(FunctionId.Copilot_On_The_Fly_Docs_Loading_State_Entered, KeyValueLogMessage.Create(m =>
         {
             m["SymbolHeaderText"] = _onTheFlyDocsElement.SymbolSignature;
+            m["HasDocumentationComments"] = _onTheFlyDocsElement.HasComments;
         }, LogLevel.Information));
 
+        OnTheFlyDocsLogger.LogOnTheFlyDocsResultsRequested();
+        if (_onTheFlyDocsElement.HasComments)
+        {
+            OnTheFlyDocsLogger.LogOnTheFlyDocsResultsRequestedWithDocComments();
+        }
+
         ResultsRequested?.Invoke(this, EventArgs.Empty);
     }
 

src/EditorFeatures/Core.Wpf/QuickInfo/OnTheFlyDocsViewFactory.cs

@@ -60,6 +60,13 @@ public OnTheFlyDocsViewFactory(IViewElementFactoryService factoryService, IAsync
             throw new InvalidOperationException("QuickInfoSession is null");
         }
 
+        OnTheFlyDocsLogger.LogShowedOnTheFlyDocsLink();
+
+        if (editorFeaturesOnTheFlyDocsElement.OnTheFlyDocsElement.HasComments)
+        {
+            OnTheFlyDocsLogger.LogShowedOnTheFlyDocsLinkWithDocComments();
+        }
+
         return new OnTheFlyDocsView(textView, _factoryService, _listenerProvider, quickInfoSession, _threadingContext, editorFeaturesOnTheFlyDocsElement) as TView;
     }
 }

src/Features/CSharp/Portable/QuickInfo/CSharpSemanticQuickInfoProvider.cs

@@ -168,6 +168,15 @@ protected override NullableFlowState GetNullabilityAnalysis(SemanticModel semant
             return null;
         }
 
+        if (symbol.MetadataToken != 0)
+        {
+            OnTheFlyDocsLogger.LogHoveredMetadataSymbol();
+        }
+        else
+        {
+            OnTheFlyDocsLogger.LogHoveredSourceSymbol();
+        }
+
         if (symbol.DeclaringSyntaxReferences.Length == 0)
         {
             return null;

src/Features/Core/Portable/Common/FeaturesSessionTelemetry.cs

@@ -4,6 +4,7 @@
 
 using Microsoft.CodeAnalysis.ChangeSignature;
 using Microsoft.CodeAnalysis.Completion.Log;
+using Microsoft.CodeAnalysis.QuickInfo;
 
 namespace Microsoft.CodeAnalysis.Common;
 
@@ -13,5 +14,6 @@ public static void Report()
     {
         CompletionProvidersLogger.ReportTelemetry();
         ChangeSignatureLogger.ReportTelemetry();
+        OnTheFlyDocsLogger.ReportTelemetry();
     }
 }

src/Features/Core/Portable/QuickInfo/OnTheFlyDocsElement.cs

@@ -12,9 +12,13 @@ namespace Microsoft.CodeAnalysis.QuickInfo;
 /// <param name="symbolSignature">formatted string representation of a symbol/></param>
 /// <param name="declarationCode">the symbol's declaration code</param>
 /// <param name="language">the language of the symbol</param>
-internal sealed class OnTheFlyDocsElement(string symbolSignature, ImmutableArray<string> declarationCode, string language)
+/// <param name="hasComments">whether the symbol has comments</param>
+internal sealed class OnTheFlyDocsElement(string symbolSignature, ImmutableArray<string> declarationCode, string language, bool hasComments = false)
 {
     public string SymbolSignature { get; } = symbolSignature;
     public ImmutableArray<string> DeclarationCode { get; } = declarationCode;
     public string Language { get; } = language;
+
+    // Added for telemetry collection purposes.
+    public bool HasComments { get; set; } = hasComments;
 }

src/Features/Core/Portable/QuickInfo/OnTheFlyDocsLogger.cs

@@ -0,0 +1,52 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using Microsoft.CodeAnalysis.Internal.Log;
+
+namespace Microsoft.CodeAnalysis.QuickInfo;
+
+internal static class OnTheFlyDocsLogger
+{
+    private static readonly CountLogAggregator<ActionInfo> s_countLogAggregator = new();
+
+    private enum ActionInfo
+    {
+        HoveredSourceSymbol,
+        HoveredMetadataSymbol,
+        ShowedOnTheFlyDocsLink,
+        ShowedOnTheFlyDocsLinkWithDocComments,
+        OnTheFlyDocsResultsRequested,
+        OnTheFlyDocsResultsRequestedWithDocComments,
+    }
+
+    internal static void LogHoveredSourceSymbol()
+        => s_countLogAggregator.IncreaseCount(ActionInfo.HoveredSourceSymbol);
+
+    internal static void LogHoveredMetadataSymbol()
+        => s_countLogAggregator.IncreaseCount(ActionInfo.HoveredMetadataSymbol);
+
+    internal static void LogShowedOnTheFlyDocsLink()
+        => s_countLogAggregator.IncreaseCount(ActionInfo.ShowedOnTheFlyDocsLink);
+
+    internal static void LogShowedOnTheFlyDocsLinkWithDocComments()
+        => s_countLogAggregator.IncreaseCount(ActionInfo.ShowedOnTheFlyDocsLinkWithDocComments);
+
+    internal static void LogOnTheFlyDocsResultsRequested()
+        => s_countLogAggregator.IncreaseCount(ActionInfo.OnTheFlyDocsResultsRequested);
+
+    internal static void LogOnTheFlyDocsResultsRequestedWithDocComments()
+        => s_countLogAggregator.IncreaseCount(ActionInfo.OnTheFlyDocsResultsRequestedWithDocComments);
+
+    public static void ReportTelemetry()
+    {
+        Logger.Log(FunctionId.InheritanceMargin_GetInheritanceMemberItems, KeyValueLogMessage.Create(m =>
+        {
+            foreach (var kv in s_countLogAggregator)
+            {
+                m[kv.Key.ToString()] = kv.Value.GetCount();
+            }
+        }));
+    }
+}

src/Features/Core/Portable/QuickInfo/QuickInfoUtilities.cs

@@ -70,7 +70,13 @@ public static async Task<QuickInfoItem> CreateQuickInfoItemAsync(
         }
 
         if (groups.TryGetValue(SymbolDescriptionGroups.Documentation, out var docParts) && !docParts.IsDefaultOrEmpty)
+        {
             AddSection(QuickInfoSectionKinds.DocumentationComments, docParts);
+            if (onTheFlyDocsElement != null)
+            {
+                onTheFlyDocsElement.HasComments = true;
+            }
+        }
 
         if (options.QuickInfoOptions.ShowRemarksInQuickInfo &&
             groups.TryGetValue(SymbolDescriptionGroups.RemarksDocumentation, out var remarksDocumentation) &&

src/VisualStudio/Core/Def/RoslynPackage.cs

@@ -13,6 +13,7 @@
 using Microsoft.CodeAnalysis.Common;
 using Microsoft.CodeAnalysis.EditAndContinue;
 using Microsoft.CodeAnalysis.Editor.Implementation.IntelliSense.AsyncCompletion;
+using Microsoft.CodeAnalysis.Editor.QuickInfo;
 using Microsoft.CodeAnalysis.Editor.Shared.Utilities;
 using Microsoft.CodeAnalysis.ErrorReporting;
 using Microsoft.CodeAnalysis.Notification;