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

Grouping Top N queries documentation #8173

Merged

Conversation

deshsidd
Copy link
Contributor

@deshsidd deshsidd commented Sep 5, 2024

Description

Grouping Top N queries documentation for query insights

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].
closes #8165
addresses opensearch-project/query-insights#66

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

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.

Signed-off-by: Siddhant Deshmukh <[email protected]>
Copy link

github-actions bot commented Sep 5, 2024

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.

@deshsidd
Copy link
Contributor Author

deshsidd commented Sep 5, 2024

@kolchfa-aws Please review the above and let me know your thoughts

deshsidd and others added 7 commits September 5, 2024 10:49
Signed-off-by: Siddhant Deshmukh <[email protected]>
Signed-off-by: Siddhant Deshmukh <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Siddhant Deshmukh <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
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, @deshsidd! Applying "Done but waiting to merge" label to put this in the 2.17 editorial queue starting 9/11. This PR will be merged before the release.

@kolchfa-aws kolchfa-aws added 6 - Done but waiting to merge PR: The work is done and ready to merge 5 - Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes v2.17.0 labels Sep 9, 2024
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@deshsidd @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

{: .label .label-purple }

Monitoring the [top N queries]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/top-n-queries/) helps identify the most resource-intensive queries based on latency, CPU, and memory usage over a specified time window. However, if a single computationally-expensive query is executed multiple times, it can occupy all top N query slots, potentially preventing other expensive queries from appearing in the list. To address this issue, you can group similar queries, gaining insight into various high-impact query groups.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Line above: FYI, no hyphen in a compound adjective if the first word is an adverb ending in -ly

_observing-your-data/query-insights/index.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws merged commit cdf4985 into opensearch-project:main Sep 11, 2024
5 checks passed
epugh pushed a commit to o19s/documentation-website that referenced this pull request Sep 12, 2024
* Grouping Top N queries documentation

Signed-off-by: Siddhant Deshmukh <[email protected]>

* Fix dead links

Signed-off-by: Siddhant Deshmukh <[email protected]>

* Fix dead link

Signed-off-by: Siddhant Deshmukh <[email protected]>

* Fix dead links

Signed-off-by: Siddhant Deshmukh <[email protected]>

* Address reviewdog comments

Signed-off-by: Siddhant Deshmukh <[email protected]>

* reviewdog fix

Signed-off-by: Siddhant Deshmukh <[email protected]>

* Doc review

Signed-off-by: Fanit Kolchina <[email protected]>

* Add table

Signed-off-by: Siddhant Deshmukh <[email protected]>

* Table review and added ability to collapse the response

Signed-off-by: Fanit Kolchina <[email protected]>

* More explanation to a couple of parameters

Signed-off-by: Fanit Kolchina <[email protected]>

* Typo fix

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Editorial comment

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _observing-your-data/query-insights/grouping-top-n-queries.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Siddhant Deshmukh <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress 6 - Done but waiting to merge PR: The work is done and ready to merge release-notes PR: Include this PR in the automated release notes v2.17.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC]Grouping Top N queries by latency and resource usage
3 participants