add document for Query Insights health_stats API #8627
Conversation
Signed-off-by: Chenyang Ji <cyji@amazon.com>
ansjcy
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
epugh
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. |
kolchfa-aws
added
4 - Doc review
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
| nav_order: 50 | ||
| --- | ||
|
|
||
| # Query Insights API |
There was a problem hiding this comment.
I would call this as just Query Insights Health API, since the previous "top queries API" should also be considered as a "query insights API". If we want to write this as a new page, we should change the title.
There was a problem hiding this comment.
I changed to "Query Insights health" and moved both subtopics under this page. Let me know what you think. Thanks!
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
…entation-website into query-insights-health-stats
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
There was a problem hiding this comment.
@kolchfa-aws @ansjcy Please see my comments and changes and let me know if you have any questions. Thanks!
| **Introduced 2.18** | ||
| {: .label .label-purple } | ||
|
|
||
| The Health Stats API provides health metrics for each node running the Query Insights plugin. These metrics allow for an in-depth view of resource usage and the query processing component health. |
There was a problem hiding this comment.
"the query processing component health" => "the health of the query processing component"?
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
kolchfa-aws
added
6 - Done but waiting to merge
…8627) * add document for Query Insights health_stats API Signed-off-by: Chenyang Ji <cyji@amazon.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _observing-your-data/query-insights/api.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Move metrics counters section Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Clarification Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change title of page Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Chenyang Ji <cyji@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Description
Add document for Query Insights health_stats API and error counter metrics.
Issues Resolved
Closes #8343
Version
2.18
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.