[Query] Adds public backend metrics property to Diagnostics

Microsoft.Azure.Cosmos/src/Diagnostics/CosmosDiagnostics.cs

@@ -5,6 +5,7 @@ namespace Microsoft.Azure.Cosmos
 {
     using System;
     using System.Collections.Generic;
+    using Microsoft.Azure.Cosmos.Query.Core.Metrics;
 
     /// <summary>
     ///  Contains the cosmos diagnostic information for the current request to Azure Cosmos DB service.
@@ -43,6 +44,16 @@ public virtual int GetFailedRequestCount()
             throw new NotImplementedException($"{nameof(CosmosDiagnostics)}.{nameof(GetFailedRequestCount)}");
         }
 
+        /// <summary>
+        ///  This represents the accumulated backend query metrics for the request.
+        /// </summary>
+        /// <returns>The accumulated backend metrics for the request.</returns>
+        public virtual BackendMetrics GetQueryMetrics()
+        {
+            // Default implementation avoids breaking change for users upgrading.
+            throw new NotImplementedException($"{nameof(CosmosDiagnostics)}.{nameof(GetQueryMetrics)}");
+        }
+
         /// <summary>
         /// Gets the string field <see cref="CosmosDiagnostics"/> instance in the Azure CosmosDB database service.
         /// </summary>

Microsoft.Azure.Cosmos/src/Diagnostics/CosmosTraceDiagnostics.cs

@@ -6,9 +6,9 @@ namespace Microsoft.Azure.Cosmos.Diagnostics
 {
     using System;
     using System.Collections.Generic;
-    using System.Linq;
     using System.Text;
     using Microsoft.Azure.Cosmos.Json;
+    using Microsoft.Azure.Cosmos.Query.Core.Metrics;
     using Microsoft.Azure.Cosmos.Tracing;
     using Microsoft.Azure.Cosmos.Tracing.TraceData;
     using static Microsoft.Azure.Cosmos.Tracing.TraceData.ClientSideRequestStatisticsTraceDatum;
@@ -49,21 +49,52 @@ public override TimeSpan GetClientElapsedTime()
             return this.Value?.Summary?.RegionsContacted;
         }
 
+        public override BackendMetrics GetQueryMetrics()
+        {
+            BackendMetrics.Accumulator accumulator = this.WalkTraceTreeForQueryMetrics(this.Value, new BackendMetrics.Accumulator());
+            return BackendMetrics.Accumulator.ToBackendMetrics(accumulator);
+
+        }
+
         internal bool IsGoneExceptionHit()
         {
             return this.WalkTraceTreeForGoneException(this.Value);
         }
 
+        private BackendMetrics.Accumulator WalkTraceTreeForQueryMetrics(ITrace currentTrace, BackendMetrics.Accumulator accumulator)
+        {
+            if (currentTrace == null)
+            {
+                return accumulator;
+            }
+
+            foreach (object datum in currentTrace.Data.Values)
+            {
+                if (datum is QueryMetricsTraceDatum queryMetricsTraceDatum)
+                {
+                    accumulator = accumulator.Accumulate(queryMetricsTraceDatum.QueryMetrics.BackendMetrics);
+                    return accumulator;
+                }
+            }
+
+            foreach (ITrace childTrace in currentTrace.Children)
+            {
+                accumulator = this.WalkTraceTreeForQueryMetrics(childTrace, accumulator);
+            }
+
+            return accumulator;
+        }
+
         private bool WalkTraceTreeForGoneException(ITrace currentTrace)
         {
             if (currentTrace == null)
             {
                 return false;
             }
 
-            foreach (object datums in currentTrace.Data.Values)
+            foreach (object datum in currentTrace.Data.Values)
             {
-                if (datums is ClientSideRequestStatisticsTraceDatum clientSideRequestStatisticsTraceDatum)
+                if (datum is ClientSideRequestStatisticsTraceDatum clientSideRequestStatisticsTraceDatum)
                 {
                     foreach (StoreResponseStatistics responseStatistics in clientSideRequestStatisticsTraceDatum.StoreResponseStatisticsList)
                     {

Microsoft.Azure.Cosmos/src/Query/Core/Metrics/BackendMetrics.cs

@@ -10,19 +10,12 @@ namespace Microsoft.Azure.Cosmos.Query.Core.Metrics
     /// <summary>
     /// Metrics received for queries from the backend.
     /// </summary>
-#if INTERNAL
-#pragma warning disable SA1600
-#pragma warning disable CS1591
-    public
-#else
-    internal
-#endif
-    sealed class BackendMetrics
+    public sealed class BackendMetrics
     {
         /// <summary>
         /// QueryMetrics that with all members having default (but not null) members.
         /// </summary>
-        public static readonly BackendMetrics Empty = new BackendMetrics(
+        internal static readonly BackendMetrics Empty = new BackendMetrics(
             retrievedDocumentCount: default,
             retrievedDocumentSize: default,
             outputDocumentCount: default,
@@ -36,7 +29,7 @@ sealed class BackendMetrics
             runtimeExecutionTimes: RuntimeExecutionTimes.Empty,
             documentWriteTime: default);
 
-        public BackendMetrics(
+        internal BackendMetrics(
            long retrievedDocumentCount,
            long retrievedDocumentSize,
            long outputDocumentCount,
@@ -124,12 +117,16 @@ public BackendMetrics(
         /// </summary>
         public TimeSpan VMExecutionTime { get; }
 
-        public override string ToString()
+        /// <summary>
+        /// String representation of BackendMetric.
+        /// </summary>
+        /// <returns>BackendMetric text</returns>
+        public override string ToString() //todo move this logic elsewhere?
         {
             return $"totalExecutionTimeInMs={this.TotalTime.TotalMilliseconds};queryCompileTimeInMs={this.QueryPreparationTimes.QueryCompilationTime.TotalMilliseconds};queryLogicalPlanBuildTimeInMs={this.QueryPreparationTimes.LogicalPlanBuildTime.TotalMilliseconds};queryPhysicalPlanBuildTimeInMs={this.QueryPreparationTimes.PhysicalPlanBuildTime.TotalMilliseconds};queryOptimizationTimeInMs={this.QueryPreparationTimes.QueryOptimizationTime.TotalMilliseconds};indexLookupTimeInMs={this.IndexLookupTime.TotalMilliseconds};documentLoadTimeInMs={this.DocumentLoadTime.TotalMilliseconds};systemFunctionExecuteTimeInMs={this.RuntimeExecutionTimes.SystemFunctionExecutionTime.TotalMilliseconds};userFunctionExecuteTimeInMs={this.RuntimeExecutionTimes.UserDefinedFunctionExecutionTime.TotalMilliseconds};retrievedDocumentCount={this.RetrievedDocumentCount};retrievedDocumentSize={this.RetrievedDocumentSize};outputDocumentCount={this.OutputDocumentCount};outputDocumentSize={this.OutputDocumentSize};writeOutputTimeInMs={this.DocumentWriteTime.TotalMilliseconds};indexUtilizationRatio={this.IndexHitRatio}";
         }
 
-        public static BackendMetrics CreateFromIEnumerable(IEnumerable<BackendMetrics> backendMetricsEnumerable)
+        internal static BackendMetrics CreateFromIEnumerable(IEnumerable<BackendMetrics> backendMetricsEnumerable)
         {
             BackendMetrics.Accumulator accumulator = default;
             foreach (BackendMetrics backendMetrics in backendMetricsEnumerable)
@@ -140,12 +137,12 @@ public static BackendMetrics CreateFromIEnumerable(IEnumerable<BackendMetrics> b
             return BackendMetrics.Accumulator.ToBackendMetrics(accumulator);
         }
 
-        public static bool TryParseFromDelimitedString(string delimitedString, out BackendMetrics backendMetrics)
+        internal static bool TryParseFromDelimitedString(string delimitedString, out BackendMetrics backendMetrics)
         {
             return BackendMetricsParser.TryParse(delimitedString, out backendMetrics);
         }
 
-        public static BackendMetrics ParseFromDelimitedString(string delimitedString)
+        internal static BackendMetrics ParseFromDelimitedString(string delimitedString)
         {
             if (!BackendMetricsParser.TryParse(delimitedString, out BackendMetrics backendMetrics))
             {
@@ -155,7 +152,7 @@ public static BackendMetrics ParseFromDelimitedString(string delimitedString)
             return backendMetrics;
         }
 
-        public ref struct Accumulator
+        internal ref struct Accumulator
         {
             public Accumulator(
                 TimeSpan totalTime,

Microsoft.Azure.Cosmos/src/Query/Core/Metrics/QueryPreparationTimes.cs

@@ -8,16 +8,9 @@ namespace Microsoft.Azure.Cosmos.Query.Core.Metrics
     /// <summary>
     /// Query preparation metrics in the Azure DocumentDB database service.
     /// </summary>
-#if INTERNAL
-#pragma warning disable SA1600
-#pragma warning disable CS1591
-    public
-#else
-    internal
-#endif
-    sealed class QueryPreparationTimes
+    public sealed class QueryPreparationTimes
     {
-        public static readonly QueryPreparationTimes Zero = new QueryPreparationTimes(
+        internal static readonly QueryPreparationTimes Zero = new QueryPreparationTimes(
             queryCompilationTime: default,
             logicalPlanBuildTime: default,
             physicalPlanBuildTime: default,
@@ -30,7 +23,7 @@ sealed class QueryPreparationTimes
         /// <param name="logicalPlanBuildTime">Query logical plan build time</param>
         /// <param name="physicalPlanBuildTime">Query physical plan build time</param>
         /// <param name="queryOptimizationTime">Query optimization time</param>
-        public QueryPreparationTimes(
+        internal QueryPreparationTimes(
             TimeSpan queryCompilationTime,
             TimeSpan logicalPlanBuildTime,
             TimeSpan physicalPlanBuildTime,
@@ -62,7 +55,7 @@ public QueryPreparationTimes(
         /// </summary>
         public TimeSpan QueryOptimizationTime { get; }
 
-        public ref struct Accumulator
+        internal ref struct Accumulator
         {
             public Accumulator(TimeSpan queryCompliationTime, TimeSpan logicalPlanBuildTime, TimeSpan physicalPlanBuildTime, TimeSpan queryOptimizationTime)
             {

Microsoft.Azure.Cosmos/src/Query/Core/Metrics/RuntimeExecutionTimes.cs

@@ -8,16 +8,9 @@ namespace Microsoft.Azure.Cosmos.Query.Core.Metrics
     /// <summary>
     /// Query runtime execution times in the Azure Cosmos DB service.
     /// </summary>
-#if INTERNAL
-#pragma warning disable SA1600
-#pragma warning disable CS1591
-    public
-#else
-    internal
-#endif
-    sealed class RuntimeExecutionTimes
+    public sealed class RuntimeExecutionTimes
     {
-        public static readonly RuntimeExecutionTimes Empty = new RuntimeExecutionTimes(
+        internal static readonly RuntimeExecutionTimes Empty = new RuntimeExecutionTimes(
             queryEngineExecutionTime: default,
             systemFunctionExecutionTime: default,
             userDefinedFunctionExecutionTime: default);
@@ -28,7 +21,7 @@ sealed class RuntimeExecutionTimes
         /// <param name="queryEngineExecutionTime">Query end - to - end execution time</param>
         /// <param name="systemFunctionExecutionTime">Total time spent executing system functions</param>
         /// <param name="userDefinedFunctionExecutionTime">Total time spent executing user - defined functions</param>
-        public RuntimeExecutionTimes(
+        internal RuntimeExecutionTimes(
             TimeSpan queryEngineExecutionTime,
             TimeSpan systemFunctionExecutionTime,
             TimeSpan userDefinedFunctionExecutionTime)
@@ -53,7 +46,7 @@ public RuntimeExecutionTimes(
         /// </summary>
         public TimeSpan UserDefinedFunctionExecutionTime { get; }
 
-        public ref struct Accumulator
+        internal ref struct Accumulator
         {
             public Accumulator(TimeSpan queryEngineExecutionTime, TimeSpan systemFunctionExecutionTime, TimeSpan userDefinedFunctionExecutionTimes)
             {
@@ -62,9 +55,9 @@ public Accumulator(TimeSpan queryEngineExecutionTime, TimeSpan systemFunctionExe
                 this.UserDefinedFunctionExecutionTime = userDefinedFunctionExecutionTimes;
             }
 
-            public TimeSpan QueryEngineExecutionTime { get; set; }
-            public TimeSpan SystemFunctionExecutionTime { get; set; }
-            public TimeSpan UserDefinedFunctionExecutionTime { get; set; }
+            public TimeSpan QueryEngineExecutionTime { get; }
+            public TimeSpan SystemFunctionExecutionTime { get; }
+            public TimeSpan UserDefinedFunctionExecutionTime { get; }
 
             public Accumulator Accumulate(RuntimeExecutionTimes runtimeExecutionTimes)
             {