Skip to content

Conversation

@aryasoni98
Copy link
Contributor

Description

This PR adds comprehensive documentation for automatic merge functionality settings in OpenSearch. Previously, users had to reference Elastic's documentation for these merge policy and scheduler settings. This change documents all merge-related index settings in the OpenSearch documentation, including:

Merge Policy Settings:

  • index.merge.policy.max_merged_segment - Maximum size of merged segments (5gb default)
  • index.merge.policy.segments_per_tier - Segments per tier for tiered merge policy (10 default)
  • index.merge.policy.max_merge_at_once - Maximum segments to merge at once during normal merging (10 default)
  • index.merge.policy.max_merge_at_once_explicit - Maximum segments to merge during explicit force merges (30 default)
  • index.merge.policy.expunge_deletes_allowed - Percentage threshold for automatic expunging of deleted documents (10.0% default)

Merge Scheduler Settings:

  • index.merge.scheduler.max_thread_count - Maximum number of merge threads
  • index.merge.scheduler.max_merge_count - Maximum number of concurrent merges

All settings are documented with clear descriptions, default values, type information, and cross-references to related documentation (such as the Force merge API). The settings are added to the existing index settings documentation page, maintaining consistency with the existing documentation style and patterns.

Issues Resolved

Closes #11406

Version

all

Frontend features

N/A - This is backend/API documentation only.

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.

@github-actions
Copy link

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.

Signed-off-by: Arya Soni <aryasoni98@gmail.com>
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, @aryasoni98. Have you tested these settings to verify that they are valid? Alternatively, you can mention code lines where these are defined in the codebase so we can verify the defaults as well. Are these static or dynamic? Thanks.

@kolchfa-aws
Copy link
Collaborator

@aryasoni98 Also, you have extraneous commits in this PR. Please rebase so the PR contains only the relevant commits.

All settings are documented with clear descriptions, default values, type information, and cross-references to related documentation (such as the Force merge API). The settings are added to the existing index settings documentation page, maintaining consistency with the existing documentation style and patterns.

I don't see this implemented but I don't think it's necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] merge settings

2 participants