Skip to content

update OSB's redline testing documentation #10185

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

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

Conversation

OVI3D0
Copy link
Member

@OVI3D0 OVI3D0 commented Jul 2, 2025

Description

Adds documentation for new CPU-based feedback to the redline testing page

Issues Resolved

Closes #[delete this text, including the brackets, and replace with the issue number]

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: Michael Oviedo <mikeovi@amazon.com>
Copy link

github-actions bot commented Jul 2, 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.

Comment on lines 114 to 115
- `--redline-cpu-check-interval`: Interval (in seconds) between CPU usage checks (default: 30).
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we just mark these as optional and remove the Optional Tuning Flags section above as they're redundant?

Copy link
Member Author

Choose a reason for hiding this comment

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

true, no need to mention the same flags in two separate sections

OVI3D0 and others added 2 commits July 7, 2025 11:09
Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added backport 3.1 4 - Doc review PR: Doc review in progress labels Jul 8, 2025
@Naarcha-AWS
Copy link
Collaborator

@OVI3D0 and @IanHoang: I added my edits. Let me know if there's anything we should adjust before passing to editorial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 3.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants