Skip to content

Commit 712b836

Browse files
KishoreKicha14Naarcha-AWSnatebower
authored
Updated the Doc for Dynamic Column Change (#9666)
* Updated the Doc for Dynamic Column Change Signed-off-by: Kishore Kumaar Natarajan <[email protected]> * Updated the Doc for Dynamic Column Change Signed-off-by: Kishore Kumaar Natarajan <[email protected]> * Update _observing-your-data/query-insights/query-insights-dashboard.md Signed-off-by: Naarcha-AWS <[email protected]> * Update query-insights-dashboard.md Signed-off-by: Naarcha-AWS <[email protected]> * Update query-insights-dashboard.md Signed-off-by: Naarcha-AWS <[email protected]> * Update query-insights-dashboard.md Signed-off-by: Kishore Kumaar Natarajan <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update query-insights-dashboard.md Signed-off-by: Naarcha-AWS <[email protected]> * Update query-insights-dashboard.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Kishore Kumaar Natarajan <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Kishore Kumaar Natarajan <[email protected]> Co-authored-by: Kishore Kumaar Natarajan <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
1 parent 8af3856 commit 712b836

File tree

4 files changed

+33
-15
lines changed

4 files changed

+33
-15
lines changed

_observing-your-data/query-insights/query-insights-dashboard.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -78,22 +78,40 @@ The **Refresh** button reloads the query data based on the selected filters and
7878

7979
### F. Metrics table
8080

81-
The metrics table displays the following metrics for each query.
82-
83-
| Metric | Description |
84-
|-------------------------|-----------------------------------------------------------------------------|
85-
| **ID** | The unique identifier for the query. |
86-
| **Type** | The type of query, such as `query`or `group`. |
87-
| **Query Count** | The number of times that the query has been executed. |
88-
| **Timestamp** | When the query was run. |
89-
| **Latency** | The time taken for the query to execute. |
90-
| **CPU Time** | The CPU resources consumed by the query. |
91-
| **Memory Usage** | The memory usage of the query. |
92-
| **Indexes** | The index or indexes on which the query was executed. |
93-
| **Search Type** | The type of search used, for example, `query then fetch`. |
94-
| **Coordinator Node ID** | The node that coordinated the query. |
95-
| **Total Shards** | The total number of shards involved in running the query. |
81+
The metrics table dynamically adapts based on your **Type** filter selection (**Query**, **Group**, or both). Dynamic columns improve clarity by showing only the relevant data for each query type.
9682

83+
When you select **queries only**, the table displays individual metrics, including **Latency**, **CPU Time**, and **Memory Usage**. The **Query Count** column isn't displayed because each row represents a single query, as shown in the following image.
84+
85+
![Column Display for Query Selected](../../images/Query-Insights/OnlyQueryColDisplay.png)
86+
87+
When you select **groups only**, the table displays aggregated metrics, including **Average Latency**, **Average CPU Time**, and **Average Memory Usage**. The **Query Count** column shows how many queries are in each group, as shown in the following image.
88+
89+
![Column Display for Group Selected](../../images/Query-Insights/OnlyGroupColDisplay.png)
90+
91+
When you select both **groups** and **queries**, the table displays combined metrics, including both averaged and raw values, as shown in the following image.
92+
93+
![Column Display for Both Selected](../../images/Query-Insights/BothColDisplay.png)
94+
95+
The following table provides descriptions for each metric and the metric's related query and group when selected.
96+
97+
| Column name | Description | Query selected | Group selected | Query + group selected |
98+
| :--- | :--- | :--- | :--- | :--- |
99+
| **ID** | The unique identifier for the query or group. | `ID` | `ID` | `ID` |
100+
| **Type** | Indicates whether the entry is a query or a group. | `Type` | `Type` | `Type` |
101+
| **Query Count** | The number of queries aggregated in the group. | Not shown | `Query Count` | `Query Count` |
102+
| **Timestamp** | The time at which the query or group was recorded (may be empty for groups). | `Timestamp` | Not shown | `Timestamp` |
103+
| **Latency** | The amount of time taken for individual queries to execute. | `Latency` | `Average Latency` | `Avg Latency/Latency` |
104+
| **CPU Time** | The number of CPU resources consumed. | `CPU Time` | `Average CPU Time` | `Avg CPU Time/CPU Time` |
105+
| **Memory Usage** | The amount of memory used during execution. | `Memory Usage` | `Average Memory Usage` | `Avg Memory Usage/Memory Usage` |
106+
| **Indexes** | A list of indexes involved in the query or group. | `Indexes` | Not shown | `Indexes` |
107+
| **Search Type** | The search execution method used (such as `query` or `fetch`). | `Search Type` | Not shown | `Search Type` |
108+
| **Coordinator Node ID** | The node that coordinated the query. | `Coordinator Node ID` | Not shown | `Coordinator Node ID` |
109+
| **Total Shards** | The number of shards involved in query processing. | `Total Shards` | Not shown | `Total Shards` |
110+
111+
When you select **Query + Group**:
112+
113+
- If all displayed rows are queries, then the table follows the **Query Selected** behavior.
114+
- If all displayed rows are groups, then the table follows the **Group Selected** behavior.
97115

98116
## Query details
99117

603 KB
Loading
225 KB
Loading
592 KB
Loading

0 commit comments

Comments
 (0)