#958 Document the exact meaning of existing search times (#969)

* docs: #958: add summary for search time results * docs: #958: wording fix * docs: #958: update MatchPredictionTime comment * docs: #958: doccoment typo fix
Anthony-Nolan · May 23, 2023 · bb96f20 · bb96f20
1 parent c46d6b7
commit bb96f20
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/Atlas.Client.Models/Search/Results/ResultSet/SearchResultSet.cs b/Atlas.Client.Models/Search/Results/ResultSet/SearchResultSet.cs
@@ -5,9 +5,16 @@ namespace Atlas.Client.Models.Search.Results.ResultSet
 {
     public abstract class SearchResultSet : ResultSet<SearchResult>
     {
+        /// <summary>
+        /// Time taken to run the matching algorithm search step
+        ///     - Does not include results upload
+        /// </summary>
         [Obsolete($"Superseded by {nameof(RequestPerformanceMetrics.AlgorithmCoreStepDuration)} in matching-algorithm-results log file")]
         public TimeSpan MatchingAlgorithmTime { get; set; }
 
+        /// <summary>
+        /// Total time taken to process all match prediction requests for all results - excludes any orchestration time that takes place before or after this step
+        /// </summary>
         [Obsolete($"Superseded by {nameof(RequestPerformanceMetrics.AlgorithmCoreStepDuration)} in atlas-search-results log file")]
         public TimeSpan MatchPredictionTime { get; set; }
     }

diff --git a/Atlas.Client.Models/Search/Results/SearchResultsNotification.cs b/Atlas.Client.Models/Search/Results/SearchResultsNotification.cs
@@ -21,7 +21,8 @@ public class SearchResultsNotification : ResultsNotification
         public SearchFailureInfo FailureInfo { get; set; }
 
         /// <summary>
-        /// Time taken to run the matching algorithm - currently includes matching, and scoring.
+        /// Time taken to run the matching algorithm search step
+        ///     - Does not include results upload
         /// </summary>
         [Obsolete($"Superseded by {nameof(RequestPerformanceMetrics.AlgorithmCoreStepDuration)} in matching-algorithm-results log file")]
         public TimeSpan MatchingAlgorithmTime { get; set; }
@@ -36,13 +37,15 @@ public class SearchResultsNotification : ResultsNotification
         public TimeSpan MatchPredictionTime { get; set; }
 
         /// <summary>
-        /// Total time between search initiation and results notification.
+        /// Time taken to run the matching algorithm search step added to search orchestration time
         /// 
-        /// Will exceed the sum of matching algorithm and match prediction, as this time also includes:
+        /// Will exceed the sum of matching algorithm search step and match prediction, as this time also includes:
         ///     - Fetching donor metadata to use in the match prediction algorithm
         ///     - Conversion of search results
         ///     - Persisting results to Azure storage
         ///     - Any other plumbing / orchestration time.
+        ///
+        /// Does not track the queue time
         /// </summary>
         [Obsolete($"Superseded by {nameof(RequestPerformanceMetrics.Duration)}")]
         public TimeSpan OverallSearchTime { get; set; }