Skip to content

Commit afad63a

Browse files
KishoreKicha14Kishore Kumaar Natarajankolchfa-awsnatebower
authored
[DOC] Update Query Insights Dashboards docs for Live Queries and WLM integration (#11185)
* Updated Live Queries + WLM intregation Signed-off-by: Kishore Kumaar Natarajan <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Update _observing-your-data/query-insights/query-insights-dashboard.md Signed-off-by: Nathan Bower <[email protected]> --------- Signed-off-by: Kishore Kumaar Natarajan <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Co-authored-by: Kishore Kumaar Natarajan <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
1 parent 36450ef commit afad63a

File tree

9 files changed

+36
-21
lines changed

9 files changed

+36
-21
lines changed

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

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Each label corresponds to the following components:
4343

4444
### A. Navigation tabs
4545

46-
The navigation tabs allow you to switch between the **Configuration** and **Top N queries** pages.
46+
The navigation tabs allow you to switch between the **Live Queries**, **Top N Queries**, and **Configuration** pages.
4747

4848
### B. Search queries bar
4949

@@ -195,13 +195,17 @@ The following image shows the live queries view.
195195

196196
The top panel in the live queries view displays the following key real-time metrics.
197197

198-
| Panel | Description |
199-
| :--- | :--- |
200-
| **Active queries** | The total number of currently executing queries. |
201-
| **Avg. elapsed time** | The average execution time of live queries. |
202-
| **Longest running query**| The duration and ID of the longest currently executing query. |
203-
| **Total CPU time** | The cumulative CPU time used by all active queries. |
204-
| **Total memory usage** | The total memory consumed by live queries. |
198+
| Panel | Description |
199+
| :--- |:----------------------------------------------------------------------------|
200+
| **Active queries** | The total number of queries currently running in the cluster. |
201+
| **Avg. elapsed time** | The average execution time across all active queries. |
202+
| **Longest running query** | The query ID and elapsed time of the longest currently running query. |
203+
| **Total CPU time** | The cumulative CPU time consumed by all active queries. |
204+
| **Total memory usage** | The total memory consumed by all active queries. |
205+
| **Total completions** | The number of queries that have successfully completed. |
206+
| **Total cancellations** | The number of queries canceled. |
207+
| **Total rejections** | The number of queries rejected. |
208+
205209

206210
### Breakdown charts
207211

@@ -221,19 +225,20 @@ Only the top 9 items are displayed individually in the chart; additional values
221225
The live queries table lists the following information for each live query.
222226

223227

224-
| Column | Description |
225-
| :--- | :--- |
226-
| **Timestamp** | The time at which the query started running. |
227-
| **Task ID** | The unique identifier for the search task. |
228-
| **Index** | The index or indexes the query is targeting. |
229-
| **Node** | The node currently running the query. |
230-
| **Time elapsed** | The execution time for the query so far (formatted). |
231-
| **CPU usage** | The cumulative CPU time used by the query. |
232-
| **Memory usage** | The amount of memory consumed by the query so far. |
233-
| **Search type** | The search execution method, such as `query_then_fetch`. |
234-
| **Coordinator node** | The node that coordinated the query. |
235-
| **Status** | The status of the query task. Can be either `running` or `cancelled`. |
236-
| **Actions** | The available controls, such as canceling the query. |
228+
| Column | Description |
229+
| :--- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
230+
| **Timestamp** | The time at which the query started running. |
231+
| **Task ID** | The unique identifier for the query task. |
232+
| **Index** | The index or indexes targeted by the query. |
233+
| **Node** | The node currently running the query. |
234+
| **Time elapsed** | The current execution time for the query, in seconds. |
235+
| **CPU usage** | The cumulative CPU time consumed by the query. |
236+
| **Memory usage** | The amount of memory consumed by the query during execution. |
237+
| **Search type** | The search execution method, such as `query_then_fetch`. |
238+
| **Coordinator node** | The node that coordinated the query execution. |
239+
| **WLM Group** | The workload group associated with the query. Displayed as plain text if workload management (WLM) is disabled or as a clickable link to the **WLM Group Details** page associated with that query when WLM is enabled. |
240+
| **Status** | The current status of the query. Values are `running` or `cancelled`. |
241+
| **Actions** | The available actions for the query, such as canceling execution. |
237242

238243
You can use the filter bar to search for queries by text or specific field values---such as node ID, index name, or task ID---and paginate the table to better analyze specific queries. The following image shows the live queries table view.
239244

@@ -244,6 +249,16 @@ The live queries table provides the following real-time monitoring controls:
244249
- **Refresh interval** – Choose the refresh frequency. This option is available only when **Auto-refresh** is enabled.
245250
- **Manual refresh** – Select the **Refresh** button to update immediately.
246251

252+
### Workload group selector
253+
254+
The **workload group selector** lets you filter and analyze active queries by workload group:
255+
256+
- By default, the selector is set to **All Workload Groups**, showing queries across the cluster.
257+
- When **WLM is disabled**, only the `DEFAULT_WORKLOAD_GROUP` option is available.
258+
- When **WLM is enabled**, the dropdown lists all available workload groups.
259+
- Selecting a specific group filters the dashboard to show only queries running under that workload group.
260+
- The [metrics](#metrics-overview) panels and charts update to display only the selected workload group.
261+
247262
### Canceling live queries
248263

249264
The live queries table provides direct controls for canceling queries that are currently running in the cluster. This allows you to immediately stop problematic or resource-intensive searches without waiting for them to finish. You can cancel live queries in the following ways:

‎images/Query-Insights/BothColDisplay.png‎

-384 KB
Loading

‎images/Query-Insights/Configuration.png‎

-222 KB
Loading

‎images/Query-Insights/Live_Queries.png‎

-28.1 KB
Loading

‎images/Query-Insights/Live_Queries_Table.png‎

60.3 KB
Loading

‎images/Query-Insights/Live_queries_visuailization.png‎

-4.95 KB
Loading

‎images/Query-Insights/OnlyGroupColDisplay.png‎

-46.3 KB
Loading

‎images/Query-Insights/OnlyQueryColDisplay.png‎

-304 KB
Loading

‎images/Query-Insights/QueryInsights.png‎

5.08 KB
Loading

0 commit comments

Comments
 (0)