[DOC-13257] Add new request fields to Query Service and Query Admin APIs (#168)

Author: rakhi-prathap

docs/modules/n1ql-rest-admin/pages/index.adoc

@@ -5606,6 +5606,25 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo
 a| String
 
 
+a| 
+*cpuTime* +
+_optional_
+a| 
+
+[markdown]
+--
+The total sum of [execTime][exec_time] across all operators.
+
+[exec_time]: ../n1ql-rest-query/index.html#exec_time     
+
+--
+
+[%hardbreaks]
+*Example:* `pass:c["90.734075ms"]`
+{blank}
+a| String (duration)
+
+
 a| 
 *elapsedTime* +
 _optional_
@@ -5638,6 +5657,25 @@ Total number of errors encountered while executing the query.
 a| Integer
 
 
+a| 
+*ioTime* +
+_optional_
+a| 
+
+[markdown]
+--
+The total sum of [servTime][serv_time] across all operators.
+
+[serv_time]: ../n1ql-rest-query/index.html#serv_time  
+
+--
+
+[%hardbreaks]
+*Example:* `pass:c["752.858519ms"]`
+{blank}
+a| String (duration)
+
+
 a| 
 *memoryQuota* +
 _optional_
@@ -5836,6 +5874,28 @@ Total amount of calendar time taken to complete the query.
 a| String (duration)
 
 
+a| 
+*sessionMemory* +
+_optional_
+a| 
+
+[markdown]
+--
+The memory session size for the request, in bytes.
+
+Each request has a dedicated memory session. 
+When a query requires a document or value, memory is allocated from this session based on the size of the document or value.
+Once the document or value is processed, the allocated memory is returned back to the session, enabling it to be reused by the request. 
+
+This metric is available only when `node-quota` and `node-quota-val-percent` are configured for the node.
+
+--
+
+[%hardbreaks]
+{blank}
+a| Integer (bytes)
+
+
 a| 
 *state* +
 _optional_
@@ -5934,6 +5994,43 @@ Username with whose privileges the query is run.
 a| String
 
 
+a| 
+*waitTime* +
+_optional_
+a| 
+
+[markdown]
+--
+The total sum of [kernTime][kern_time] across all operators.
+
+[kern_time]: ../n1ql-rest-query/index.html#kern_time  
+
+--
+
+[%hardbreaks]
+*Example:* `pass:c["1.201307s"]`
+{blank}
+a| String (duration)
+
+
+a| 
+*~analysis* +
+_optional_
+a| 
+
+[markdown]
+--
+An array of text phrases that provide a basic analysis of the request execution. 
+These phrases highlight notable aspects of the execution, such as high document counts during primary scans or warnings related to memory and resource usages.
+
+--
+
+[%hardbreaks]
+*Example:* `["High IO time","High primary scan document count"]`
+{blank}
+a| String
+ array
+
 |===
 
 //end::Requests[]

docs/modules/n1ql-rest-query/pages/index.adoc

@@ -1191,6 +1191,26 @@ The number of warnings that occurred during the request.
 a| Integer (unsigned)
 
 
+a| 
+*sessionMemory* +
+_optional_
+a| 
+
+[markdown]
+--
+The memory session size for the request, in bytes.
+
+Each request has a dedicated memory session.  When a query requires a document or value, memory is allocated from this session based on the size of the document or value. Once the document or value is processed, the allocated memory is returned back to the session, enabling it to be reused by the request. 
+
+This metric is available only when `node-quota` and `node-quota-val-percent` are configured for the node.
+
+--
+
+[%hardbreaks]
+{blank}
+a| Integer (bytes)
+
+
 |===
 
 //end::Metrics[]
@@ -1340,6 +1360,75 @@ include::index.adoc[tag=desc-Execution_Timings, opts=optional]
 a| <<Execution_Timings>>
 
 
+a| 
+*ioTime* +
+_optional_
+a| 
+
+[markdown]
+--
+The total sum of [servTime](#serv_time) across all operators.
+
+--
+
+[%hardbreaks]
+*Example:* `pass:c["752.858519ms"]`
+{blank}
+a| String (duration)
+
+
+a| 
+*waitTime* +
+_optional_
+a| 
+
+[markdown]
+--
+The total sum of [kernTime](#kern_time) across all operators.
+
+--
+
+[%hardbreaks]
+*Example:* `pass:c["1.201307s"]`
+{blank}
+a| String (duration)
+
+
+a| 
+*cpuTime* +
+_optional_
+a| 
+
+[markdown]
+--
+The total sum of [execTime](#exec_time) across all operators.
+
+--
+
+[%hardbreaks]
+*Example:* `pass:c["90.734075ms"]`
+{blank}
+a| String (duration)
+
+
+a| 
+*~analysis* +
+_optional_
+a| 
+
+[markdown]
+--
+An array of text phrases that provide a basic analysis of the request execution. 
+These phrases highlight notable aspects of the execution, such as high document counts during primary scans or warnings related to memory and resource usages.
+
+--
+
+[%hardbreaks]
+*Example:* `["High IO time","High primary scan document count"]`
+{blank}
+a| String
+ array
+
 |===
 
 //end::Profile[]
@@ -2788,7 +2877,7 @@ Number of switches between executing, waiting for services, or waiting for the g
 a| Integer (int32)
 
 
-a| 
+a| [#exec_time]
 *execTime* +
 _optional_
 a| 
@@ -2804,7 +2893,7 @@ Time spent executing the operator code inside SQL++ query engine.
 a| String (duration)
 
 
-a| 
+a| [#kern_time]
 *kernTime* +
 _optional_
 a| 
@@ -2820,7 +2909,7 @@ Time spent waiting to be scheduled for CPU time.
 a| String (duration)
 
 
-a| 
+a| [#serv_time]
 *servTime* +
 _optional_
 a| 

src/admin/swagger/admin.yaml

@@ -660,6 +660,15 @@ components:
           [client_context_id]: ../n1ql-rest-query/index.html#client_context_id
         x-desc-refs: |
           [client_context_id]: #client_context_id
+      cpuTime:
+        type: string
+        format: duration
+        description: |
+          The total sum of [execTime][exec_time] across all operators.
+
+          [exec_time]: ../n1ql-rest-query/index.html#exec_time     
+        x-has-example: true
+        example: "90.734075ms"    
       elapsedTime:
         type: string
         format: duration
@@ -669,6 +678,15 @@ components:
       errorCount:
         type: integer
         description: Total number of errors encountered while executing the query.
+      ioTime:
+        type: string
+        format: duration
+        description: |
+          The total sum of [servTime][serv_time] across all operators.
+
+          [serv_time]: ../n1ql-rest-query/index.html#serv_time  
+        x-has-example: true
+        example: "752.858519ms"  
       memoryQuota:
         type: integer
         description: |
@@ -747,6 +765,17 @@ components:
         type: string
         format: duration
         description: Total amount of calendar time taken to complete the query.
+      sessionMemory:
+        type: integer
+        format: bytes
+        description: |
+          The memory session size for the request, in bytes.
+
+          Each request has a dedicated memory session. 
+          When a query requires a document or value, memory is allocated from this session based on the size of the document or value.
+          Once the document or value is processed, the allocated memory is returned back to the session, enabling it to be reused by the request. 
+
+          This metric is available only when `node-quota` and `node-quota-val-percent` are configured for the node.
       state:
         type: string
         description: |
@@ -773,6 +802,28 @@ components:
       users:
         type: string
         description: Username with whose privileges the query is run.
+      waitTime:
+        type: string
+        format: duration
+        description: |
+          The total sum of [kernTime][kern_time] across all operators.
+
+          [kern_time]: ../n1ql-rest-query/index.html#kern_time  
+        x-has-example: true
+        example: "1.201307s"  
+      ~analysis:
+          type: array
+          items:
+            type: string
+          description: |
+            An array of text phrases that provide a basic analysis of the request execution. 
+            These phrases highlight notable aspects of the execution, such as high document counts during primary scans or warnings related to memory and resource usages.
+          x-has-example: true
+          example: 
+              [                      
+                "High IO time",
+                "High primary scan document count"              
+              ]  
 
   Statements:
     type: object