[FEATURE] Query Insights Dashboards

[ansjcy]

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

Screen 2: Query details screen. Users can click on the time stamp to drill down and view the details of the query.

Screen 3: Configuration tab displays the default configuration settings. Users with appropriate edit access can modify the configuration settings.

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.

Screen 3b. Updated configuration is saved once user clicks “Save“.

What alternatives have you considered?

N/A

Do you have any additional context?

opensearch-project/OpenSearch#11522

[dblock]

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

[ansjcy]

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

[ansjcy]

Reopen it for releasing in 2.19

[ansjcy]

Below items are needed for 2.19 release:
Features:

• [FEATURE] Better configuration endpoint to control index lifecycle query-insights#165
• [FEATURE] Integrate grouping top N queries with dashboards #14
• [FEATURE] Add an ID Field to Search Query Records query-insights#159

Bug fixes:

• [BUG] Error when initializing operational metrics query-insights#164
• [BUG] Incorrect Top N value displayed in the configurations page #31
• [BUG] Query displayed in details page does not match the input query #30
• [BUG] Transient settings not taken into effect #29
• [BUG] Query Details page crash when refreshing #12