mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-03-09 14:38:01 +00:00
c87bd64a57
* Query Insights initial documentation Signed-off-by: Chenyang Ji <cyji@amazon.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * update endpoints and remove exporters Signed-off-by: Chenyang Ji <cyji@amazon.com> * Moved query insights to additional plugins section Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added installation instructions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * merge conflicts and link fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Chenyang Ji <cyji@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
39 lines
1.8 KiB
Markdown
39 lines
1.8 KiB
Markdown
---
|
|
layout: default
|
|
title: Query insights
|
|
nav_order: 40
|
|
has_children: true
|
|
has_toc: false
|
|
---
|
|
|
|
# Query insights
|
|
|
|
To monitor and analyze the search queries within your OpenSearch clusterQuery information, you can obtain query insights. With minimal performance impact, query insights features aim to provide comprehensive insights into search query execution, enabling you to better understand search query characteristics, patterns, and system behavior during query execution stages. Query insights facilitate enhanced detection, diagnosis, and prevention of query performance issues, ultimately improving query processing performance, user experience, and overall system resilience.
|
|
|
|
Typical use cases for query insights features include the following:
|
|
|
|
- Identifying top queries by latency within specific time frames
|
|
- Debugging slow search queries and latency spikes
|
|
|
|
Query insights features are supported by the Query Insights plugin. At a high level, query insights features comprise the following components:
|
|
|
|
* _Collectors_: Gather performance-related data points at various stages of search query execution.
|
|
* _Processors_: Perform lightweight aggregation and processing on data collected by the collectors.
|
|
* _Exporters_: Export the data into different sinks.
|
|
|
|
|
|
## Installing the Query Insights plugin
|
|
|
|
You need to install the `query-insights` plugin to enable query insights features. To install the plugin, run the following command:
|
|
|
|
```bash
|
|
bin/opensearch-plugin install query-insights
|
|
```
|
|
For information about installing plugins, see [Installing plugins]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/).
|
|
|
|
## Query insights settings
|
|
|
|
Query insights features support the following settings:
|
|
|
|
- [Top n queries]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/top-n-queries/)
|