Skip to content

Commit 805cc78

Browse files
KishoreKicha14Kishore Kumaar NatarajanNaarcha-AWSnatebower
authored
[Doc] Live Queries dashboard (opensearch-project#10090)
* Live Queries Dash Signed-off-by: Kishore Kumaar Natarajan <kkumaarn@amazon.com> * Add writer edits Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update query-insights-dashboard.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix table information Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: Kishore Kumaar Natarajan <kkumaarn@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: Kishore Kumaar Natarajan <kkumaarn@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
1 parent 5dd0c47 commit 805cc78

File tree

4 files changed

+68
-0
lines changed

4 files changed

+68
-0
lines changed

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

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The **Query insights** dashboard contains the following pages:
2121
- [Top N queries](#top-n-queries): Displays the query metrics and details for the top queries.
2222
- [Query details](#query-details): Displays details for individual queries and query groups.
2323
- [Configuration](#configuration): Customizes all monitoring and data retention settings for the query insights feature.
24+
- [Live queries](#live-queries): Monitors currently running queries in real time.
2425

2526

2627
## Top N queries
@@ -182,6 +183,73 @@ When configuring the query insights feature, remember the following best practic
182183
- When setting data retention periods, consider shorter retention periods that save storage but reduce the number of long-term insights.
183184
- Enable metrics based on your monitoring needs. Monitoring fewer metrics prevents system overload.
184185

186+
## Live queries
187+
188+
The **Live queries** page provides real-time visibility into search queries currently running in your OpenSearch cluster. It enables active monitoring, fast debugging, and insight into how a query's load is distributed across nodes and indexes.
189+
190+
The following image shows the live queries view.
191+
192+
![Live Queries Dashboard]({{site.url}}{{site.baseurl}}/images/Query-Insights/Live_Queries.png)
193+
194+
### Metrics overview
195+
196+
The top panel in the live queries view displays the following key real-time metrics.
197+
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. |
205+
206+
### Breakdown charts
207+
208+
Two visual charts provide breakdowns of query load:
209+
210+
- **By node** – Shows how many queries are running on each node.
211+
- **By index** – Displays how many queries are targeting each index.
212+
213+
![Live Queries visual charts]({{site.url}}{{site.baseurl}}/images/Query-Insights/Live_queries_visuailization.png)
214+
215+
You can toggle between **Donut** and **Bar** chart formats using the chart type switch.
216+
217+
Only the top 9 items are displayed individually in the chart; additional values are grouped under the **Others** category.
218+
219+
### Live query table
220+
221+
The live query table lists the following information for each live query.
222+
223+
![Live Queries Table]({{site.url}}{{site.baseurl}}/images/Query-Insights/Live_Queries_Table.png)
224+
225+
| Column | Description |
226+
| :--- | :--- |
227+
| **Timestamp** | The time when the query started running. |
228+
| **Task ID** | The unique identifier for the search task. |
229+
| **Index** | The index or indexes the query is targeting. |
230+
| **Node** | The node currently running the query. |
231+
| **Time elapsed** | The execution time for the query so far (formatted). |
232+
| **CPU usage** | The cumulative CPU time used by the query. |
233+
| **Memory usage** | The amount of memory consumed by the query so far. |
234+
| **Search type** | The search execution method, such as `query_then_fetch`. |
235+
| **Coordinator node** | The node that coordinated the query. |
236+
| **Status** | The status of the query task. Can be either `running` or `cancelled`. |
237+
| **Actions** | The available controls, such as canceling the query. |
238+
239+
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.
240+
241+
![Live Queries Table]({{site.url}}{{site.baseurl}}/images/Query-Insights/Live_Queries_Table.png)
242+
243+
The live queries table also allows you to cancel individual or multiple running queries directly, providing real-time control. It supports the following actions:
244+
245+
- **Auto-refresh toggle** – Enable or disable periodic data refresh.
246+
- **Refresh interval** – Choose the refresh frequency. This option is available only when **Auto-refresh** is enabled.
247+
- **Manual refresh** – Select the **Refresh** button to update immediately.
248+
- **Cancel query** – Cancel an individual query using the trash icon in the action columns for the query you want to cancel.
249+
- **Bulk cancel** – Select multiple queries and cancel them all together.
250+
251+
252+
185253

186254

187255

331 KB
Loading
193 KB
Loading
50.4 KB
Loading

0 commit comments

Comments
 (0)