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

Doc change: Added troubleshooting section for knife search #8724

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

Conversation

talktovikas
Copy link
Collaborator

@talktovikas talktovikas commented Dec 27, 2024

🔩 Description: What code changed, and why?

https://progresssoftware.atlassian.net/browse/CHEF-5783

⛓️ Related Resources

👍 Definition of Done

Added a section in automate troubleshooting, for knife search issue.

👟 How to Build and Test the Change

✅ Checklist

All PRs must tick these:

With occasional exceptions, all PRs from Progress employees must tick these:

  • Is the code clear? (complicated code or lots of comments--subdivide and use well-named methods, meaningful variable names, etc.)
  • Consistency checked? (user notifications, user prompts, visual patterns, code patterns, variable names)
  • Repeated code blocks eliminated? (adapt and reuse existing components, blocks, functions, etc.)
  • Spelling, grammar, typos checked? (at a minimum use make spell in any component directory)
  • Code well-formatted? (indents, line breaks, etc. improve rather than hinder readability)

All PRs from Progress employees should tick these if appropriate:

  • Tests added/updated? (all new code needs new tests)
  • Docs added/updated? (all customer-facing changes)

Please add a note next to any checkbox above if you are NOT ticking it.

📷 Screenshots, if applicable

@talktovikas talktovikas requested a review from a team as a code owner December 27, 2024 09:20
@github-actions github-actions bot added the documentation Anything related to the Automate docs. label Dec 27, 2024
Copy link

netlify bot commented Dec 27, 2024

Deploy Preview for chef-automate ready!

Name Link
🔨 Latest commit 5414352
🔍 Latest deploy log https://app.netlify.com/sites/chef-automate/deploys/676e9ae73fd33e000806c57e
😎 Deploy Preview https://deploy-preview-8724--chef-automate.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@talktovikas
Copy link
Collaborator Author

Screenshot 2024-12-27 at 2 53 44 PM


### Fixes

This happens because OpenSearch,by default, limits the maximum number of records(or document) returned in a single query to **10000**. This is a safeguard to prevent large queries from overloading the system. If you are trying to retrive more than **10000** records, this approach will do that.

Choose a reason for hiding this comment

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

missing a space after , and before by
missing a space after records and before (
document should be documents, surely?
retrive should be retrieve

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you for reviewing. I pushed the fix.


This happens because OpenSearch,by default, limits the maximum number of records(or document) returned in a single query to **10000**. This is a safeguard to prevent large queries from overloading the system. If you are trying to retrive more than **10000** records, this approach will do that.

Change the max_result_window to accomodate more than **10000** records.

Choose a reason for hiding this comment

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

should be accommodate

Signed-off-by: talktovikas <[email protected]>

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the Automate docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants