[DOC] Update Query Insights Dashboards docs for Live Queries and WLM integration #11185
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
KishoreKicha14
requested review from
kolchfa-aws,
AMoo-Miki,
natebower,
dlvenable,
epugh and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
KishoreKicha14
changed the title
kolchfa-aws
added
Tech review
ansjcy
approved these changes
Oct 6, 2025
kolchfa-aws
added
Doc review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The Query Insights Dashboards documentation needs to be updated to reflect the new Live Queries functionality and its integration with Workload Management (WLM) in OpenSearch 3.3.
Requested changes
Add a Live Queries section with details on:
Metrics panels (active queries, avg. elapsed time, longest running query, CPU, memory, completions, cancellations, rejections).
Workload Group selector (default: All Workload Groups, behavior when WLM is disabled vs. enabled).
Table columns, including the new WLM Group column and its behavior (plain text if WLM disabled, clickable link if WLM enabled).
Update Navigation tabs description to include Live Queries, alongside Top N Queries and Configuration.
Expand metrics documentation to cover query completions, cancellations, and rejections.
Clarify WLM integration cases:
Case 1: WLM disabled → only DEFAULT_WORKLOAD_GROUP, not clickable.
Case 2: WLM enabled → workload group column clickable and navigation enabled between QI and WLM dashboards.
Version
Applies to OpenSearch 3.3.
Issues Resolved
Closes #11184
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.