Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Query Insights Dashboards - MVP #5

Closed
ansjcy opened this issue Jun 18, 2024 · 2 comments
Closed

[FEATURE] Query Insights Dashboards - MVP #5

ansjcy opened this issue Jun 18, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@ansjcy
Copy link
Member

ansjcy commented Jun 18, 2024

Is your feature request related to a problem?

In the recent releases, we have built the backend framework and APIs for query insights, including the capability to identify the top N queries based on various metrics. However, users currently lack a dashboard tool to visualize and analyze this data. They can only query the top N queries via an API and must manually aggregate and interpret historical data on their own for visualization purposes. This process is cumbersome and limits the ability to quickly diagnose and resolve performance issues.

What solution would you like?

  • Develop the MVP verison of the query-insights-dashboards plugin, with the best practices mentioned in the dashboard plugin development guide.
  • Integrate the dashboard with the top n queries API, to develop the overview page on point-in-time top n queries in the current cluster. Fill any gaps in the API (if there’s any).
  • Integrate with the top n queries exporter, to display historical top n queries on the overview page. Fill any gaps in the exporter (if there’s any).
  • Develop the drill-down view for the top queries, for detailed query analysis.
  • Develop the configuration view to more easily configure the query insights plugin.

Mock screens

Screen 1: Top N queries overview page. Users will be able to see the top queries
image
Screen 2: Query details screen. Users can click on the time stamp to drill down and view the details of the query.
image
Screen 3: Configuration tab displays the default configuration settings. Users with appropriate edit access can modify the configuration settings.
image
Screen 3a. While an edit is being made, the bottom bar is displayed with actions to save/cancel, along with the status of number of unsaved changes.
image
Screen 3b. Updated configuration is saved once user clicks “Save“.
image

What alternatives have you considered?

N/A

Do you have any additional context?

opensearch-project/OpenSearch#11522

@ansjcy ansjcy added enhancement New feature or request untriaged labels Jun 18, 2024
@ansjcy ansjcy assigned ansjcy and unassigned ansjcy Jun 25, 2024
@dblock
Copy link
Member

dblock commented Jul 8, 2024

[Catch All Triage, attendees 1, 2, 3, 4, 5, 6, 7]

@ansjcy
Copy link
Member Author

ansjcy commented Sep 5, 2024

Closing this issue since PRs for all MVP pages are already merged.
Thanks @LilyCaroline17 for your hard work!

@ansjcy ansjcy closed this as completed Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants