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.

Sign up for GitHub

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

Jump to bottom

[Doc] QueryInsightsDashboard #9157

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open

[Doc] QueryInsightsDashboard #9157

wants to merge 30 commits into from
+178 −0

Conversation

KishoreKicha14
Copy link

@KishoreKicha14 KishoreKicha14 commented Feb 5, 2025 •
edited by kolchfa-aws
Loading

Description

This change introduces documentation for the Query Insights Dashboard, explaining its features, navigation, and usage to help users understand and optimize query behavior.

Issues Resolved

Closes #9073

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.

Doc-QueryInsightsDashboard
8258693 
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 5, 2025

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 KishoreKicha14 mentioned this pull request Feb 5, 2025
Open
4 tasks
@Naarcha-AWS Naarcha-AWS added 3 - Tech review PR: Tech review in progress v2.19.0 release-notes PR: Include this PR in the automated release notes labels Feb 5, 2025
@ansjcy
Copy link
Member

ansjcy commented Feb 5, 2025

@KishoreKicha14 We don't need separate md pages for different screens. Could you combine the pages together into one page under query-insights section? Maybe call it Query Insights dashboards and visualizations.

Kishore Kumaar Natarajan and others added 5 commits February 5, 2025 13:02
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Feb 7, 2025
@ansjcy
Copy link
Member

ansjcy commented Feb 7, 2025

@KishoreKicha14 Could you also fix the issues identified by the style-job?

Naarcha-AWS
Naarcha-AWS requested changes Feb 10, 2025
View reviewed changes
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

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

Added my edits and fixed the metadata so the page appears. @KishoreKicha14, there's a couple of clarifications I need before I pass this editorial review.

_observing-your-data/query-insights/Query-insights-Dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/Query-insights-Dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/Query-insights-Dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/Query-insights-Dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/Query-insights-Dashboard.md Outdated Show resolved Hide resolved
KishoreKicha14 and others added 2 commits February 10, 2025 12:13
@KishoreKicha14
Update query-insights-dashboard.md
3c89083 
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
@Naarcha-AWS
Delete redundant sentences
d4b4e17 
Signed-off-by: Naarcha-AWS <[email protected]>
@KishoreKicha14
Update query-insights-dashboard.md
c34ffe7 
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
ansjcy
ansjcy suggested changes Feb 10, 2025
View reviewed changes
_observing-your-data/query-insights/query-insights-dashboard.md Outdated
1. From the **Query insights** page, Navigate to the **Configuration** tab from the **Query insights** page.
2. Select the metric type from **Latency, CPU Usage, or Memory**.
3. Toggle the Enabled setting to turn Top N Queries feature on or off for the selected metric.
4. Specify the monitoring **Window size**, determining the time duration for the query analysis.
Copy link
Member

Choose a reason for hiding this comment

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

determining the time duration for the query analysis

This is very ambigious, could you update based on https://opensearch.org/docs/latest/observing-your-data/query-insights/top-n-queries/#configuring-the-window-size?

Copy link
Member

Choose a reason for hiding this comment

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

Also another issue regarding window size: #9157 (comment)

@Naarcha-AWS
Small tweaks
d1dde0d 
Signed-off-by: Naarcha-AWS <[email protected]>
KishoreKicha14 and others added 3 commits February 10, 2025 13:12
@KishoreKicha14 @Naarcha-AWS
Update _observing-your-data/query-insights/query-insights-dashboard.md
c55bff3 
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
@KishoreKicha14 @Naarcha-AWS
Update _observing-your-data/query-insights/query-insights-dashboard.md
baa302f 
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
@KishoreKicha14
Update query-insights-dashboard.md
335d898 
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Feb 10, 2025
@Naarcha-AWS
Copy link
Collaborator

@natebower: This is ready for editorial review.

natebower
natebower reviewed Feb 11, 2025
View reviewed changes
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.

@Naarcha-AWS @KishoreKicha14 Please see my comments and changes and let me know if you have any questions. Thanks!

_observing-your-data/query-insights/query-insights-dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Outdated Show resolved Hide resolved
_observing-your-data/query-insights/query-insights-dashboard.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 3 commits February 10, 2025 19:08
@Naarcha-AWS @natebower
Apply suggestions from code review
257e3cf 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@KishoreKicha14 @natebower
Update _observing-your-data/query-insights/query-insights-dashboard.md
045b18e 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
@KishoreKicha14 @natebower
Update _observing-your-data/query-insights/query-insights-dashboard.md
ef8ebce 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Naarcha-AWS Naarcha-AWS Naarcha-AWS approved these changes

@natebower natebower natebower left review comments

@ansjcy ansjcy ansjcy approved these changes

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@epugh epugh Awaiting requested review from epugh epugh is a code owner

Assignees

@Naarcha-AWS Naarcha-AWS

Labels
5 - Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes v2.19.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Query Insights Dashboards Documentation
5 participants
@KishoreKicha14 @ansjcy @Naarcha-AWS @natebower @kolchfa-aws