Skip to content

docs: Update live queries documentation with new response format#12186

Merged
kolchfa-aws merged 3 commits intoopensearch-project:mainfrom
KishoreKicha14:update-live-queries-docs
Apr 6, 2026
Merged

docs: Update live queries documentation with new response format#12186
kolchfa-aws merged 3 commits intoopensearch-project:mainfrom
KishoreKicha14:update-live-queries-docs

Conversation

@KishoreKicha14
Copy link
Copy Markdown
Contributor

@KishoreKicha14 KishoreKicha14 commented Apr 1, 2026

Description

Update the live queries API documentation to reflect the restructured response model in the query-insights plugin. Changes include:

  • Updated response format to match the new LiveQueryRecord model with coordinator_task and shard_tasks breakdowns replacing the old flat measurements structure
  • Documented new query parameters: wlmGroupId for workload management group filtering and use_finished_cache for including recently completed queries
  • Added a detailed "Finished queries cache" section covering the full cache lifecycle (lazy activation, idle timeout auto-deactivation, self-healing reactivation) and the search.insights.live_queries.cache.idle_timeout cluster setting
  • Added field-by-field explanations of the live query response (top-level summary, coordinator task, shard tasks) and finished query response (id correlation, top_n_id linkage)
  • Updated all response field tables to match the current code

Issues Resolved

Closes[]

Version

3.6

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

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 1, 2026

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc 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).

Update the live queries API documentation to reflect the restructured
response model including coordinator/shard task breakdowns, finished
queries cache lifecycle, new query parameters (wlmGroupId,
use_finished_cache), and detailed field explanations for both live
and finished query responses.

Signed-off-by: Kishore Kumaar Natarajan <kkumaarn@amazon.com>
@KishoreKicha14 KishoreKicha14 force-pushed the update-live-queries-docs branch from 1a257b3 to 84e120e Compare April 1, 2026 07:14
@kolchfa-aws kolchfa-aws added Tech review PR: Tech review in progress release-notes PR: Include this PR in the automated release notes v3.6.0 labels Apr 1, 2026
@kolchfa-aws
Copy link
Copy Markdown
Collaborator

@KishoreKicha14 Is this ready for doc review?

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Apr 3, 2026
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Copy link
Copy Markdown
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @KishoreKicha14! Doc review complete.

@kolchfa-aws kolchfa-aws merged commit 4d9bb66 into opensearch-project:main Apr 6, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.6.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants