Skip to content

Latest commit

 

History

History
37 lines (21 loc) · 2.99 KB

README.md

File metadata and controls

37 lines (21 loc) · 2.99 KB
Raw

OpenSearch Query Insights Dashboards

Introduction

This is a OpenSearch-Dashboard plugin for Query Insights.

OpenSearch stands as a versatile, scalable, open-source solution designed for diverse data exploration needs, ranging from interactive log analytics to real-time application monitoring. Despite its capabilities, OpenSearch users and administrators often encounter challenges in ensuring optimal search performance due to limited expertise or OpenSearch's current constraints in providing comprehensive data points on query executions. Common questions include:

  • “What are the top queries with highest latency/CPU usages in the last 1 hour” (Identification of top queries by certain resource usages within a specific timeframe).
  • “How do I associate queries to users” (Profiling users with the highest search query volumes).
  • “Why my search queries are so slow” (Concerns about slow search queries).
  • “Why there was a spike in my search latency chart” (Spikes in query latency).

The overarching objective of the Query Insights initiative is to address these issues by building frameworks, APIs, and dashboards, with minimal performance impact, to offer profound insights, metrics and recommendations into query executions, empowering users to better understand search query characteristics, patterns, and system behavior during query execution stages. Query Insights will facilitate enhanced detection, diagnosis, and prevention of query performance issues, ultimately improving query processing performance, user experience, and overall system resilience.

Query Insights and this dashboard plugin project was originally proposed in the OpenSearch Query Insights RFC and OpenSearch Query Insights Dashboards RFC

Project Style Guidelines

The OpenSearch Project style guidelines and OpenSearch terms documents provide style standards and terminology to be observed when creating OpenSearch Project content.

Getting Help

  • For questions or help getting started, please find us in the OpenSearch Slack in the #plugins channel.
  • For bugs or feature requests, please create a new issue.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact [email protected] with any additional questions or comments.

License

This project is licensed under the Apache v2.0 License.

Copyright

Copyright OpenSearch Contributors. See NOTICE for details.