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

Changed documentation for incorrect parameters #6862

Merged
merged 8 commits into from
Apr 5, 2024

Conversation

niyatiagg
Copy link
Contributor

@niyatiagg niyatiagg commented Apr 2, 2024

Description

Changed the description of search.cancel_after_time_interval and search.default_search_timeout parameters.

Issues Resolved

Closes [#6843]

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.

…nd search.default_search_timeout parameters

Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
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.

I'm slightly confused as the why timeout is specified in the setting that says after_time_interval versus the search_timeout setting? Can you provide some additional context here?

@Naarcha-AWS Naarcha-AWS self-assigned this Apr 3, 2024
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress backport 2.13 PR: Backport label for 2.13 labels Apr 3, 2024
@jainankitk
Copy link
Contributor

I'm slightly confused as the why timeout is specified in the setting that says after_time_interval versus the search_timeout setting? Can you provide some additional context here?

The search.default_search_timeout setting was originally present, but it only timed out for shard level tasks. We wanted to achieve the same at request level, but did not want to change the behavior of existing setting. Hence, introduced new setting for this. This issue has more context - https://github.com/opensearch-project/OpenSearch#817

niyatiagg and others added 3 commits April 4, 2024 11:32
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>
Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
@Naarcha-AWS Naarcha-AWS merged commit 326cb5d into opensearch-project:main Apr 5, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 5, 2024
* Made changes to documentation for search.cancel_after_time_interval and search.default_search_timeout parameters

Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>

* Update _install-and-configure/configuring-opensearch/search-settings.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>

* Update _install-and-configure/configuring-opensearch/search-settings.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>

* Fixing typos

Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>

* Adding suggested changes

Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>

---------

Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
(cherry picked from commit 326cb5d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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 2.13 PR: Backport label for 2.13
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants