Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 36 additions & 21 deletions _observing-your-data/query-insights/query-insights-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Each label corresponds to the following components:

### A. Navigation tabs

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

### B. Search queries bar

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

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

| Panel | Description |
| :--- | :--- |
| **Active queries** | The total number of currently executing queries. |
| **Avg. elapsed time** | The average execution time of live queries. |
| **Longest running query**| The duration and ID of the longest currently executing query. |
| **Total CPU time** | The cumulative CPU time used by all active queries. |
| **Total memory usage** | The total memory consumed by live queries. |
| Panel | Description |
| :--- |:----------------------------------------------------------------------------|
| **Active queries** | The total number of queries currently running in the cluster. |
| **Avg. elapsed time** | The average execution time across all active queries. |
| **Longest running query** | The query ID and elapsed time of the longest currently running query. |
| **Total CPU time** | The cumulative CPU time consumed by all active queries. |
| **Total memory usage** | The total memory consumed by all active queries. |
| **Total completions** | The number of queries that have successfully completed. |
| **Total cancellations** | The number of queries canceled. |
| **Total rejections** | The number of queries rejected. |


### Breakdown charts

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


| Column | Description |
| :--- | :--- |
| **Timestamp** | The time at which the query started running. |
| **Task ID** | The unique identifier for the search task. |
| **Index** | The index or indexes the query is targeting. |
| **Node** | The node currently running the query. |
| **Time elapsed** | The execution time for the query so far (formatted). |
| **CPU usage** | The cumulative CPU time used by the query. |
| **Memory usage** | The amount of memory consumed by the query so far. |
| **Search type** | The search execution method, such as `query_then_fetch`. |
| **Coordinator node** | The node that coordinated the query. |
| **Status** | The status of the query task. Can be either `running` or `cancelled`. |
| **Actions** | The available controls, such as canceling the query. |
| Column | Description |
| :--- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Timestamp** | The time at which the query started running. |
| **Task ID** | The unique identifier for the query task. |
| **Index** | The index or indexes targeted by the query. |
| **Node** | The node currently running the query. |
| **Time elapsed** | The current execution time for the query, in seconds. |
| **CPU usage** | The cumulative CPU time consumed by the query. |
| **Memory usage** | The amount of memory consumed by the query during execution. |
| **Search type** | The search execution method, such as `query_then_fetch`. |
| **Coordinator node** | The node that coordinated the query execution. |
| **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. |
| **Status** | The current status of the query. Values are `running` or `cancelled`. |
| **Actions** | The available actions for the query, such as canceling execution. |

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.

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

### Workload group selector

The **workload group selector** lets you filter and analyze active queries by workload group:

- By default, the selector is set to **All Workload Groups**, showing queries across the cluster.
- When **WLM is disabled**, only the `DEFAULT_WORKLOAD_GROUP` option is available.
- When **WLM is enabled**, the dropdown lists all available workload groups.
- Selecting a specific group filters the dashboard to show only queries running under that workload group.
- The [metrics](#metrics-overview) panels and charts update to display only the selected workload group.

### Canceling live queries

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:
Expand Down
Binary file modified images/Query-Insights/BothColDisplay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Query-Insights/Configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Query-Insights/Live_Queries.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Query-Insights/Live_Queries_Table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Query-Insights/Live_queries_visuailization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Query-Insights/OnlyGroupColDisplay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Query-Insights/OnlyQueryColDisplay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Query-Insights/QueryInsights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading