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] Add a new request field to segment replication backpressure #5075

Open
1 of 4 tasks
Poojita-Raj opened this issue Sep 21, 2023 · 2 comments
Open
1 of 4 tasks

[DOC] Add a new request field to segment replication backpressure #5075

Poojita-Raj opened this issue Sep 21, 2023 · 2 comments
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. v2.10.0
Milestone

Comments

@Poojita-Raj
Copy link
Contributor

Poojita-Raj commented Sep 21, 2023

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
There's a list of fields for segment replication backpressure listed in this doc:
https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/segment-replication/backpressure/#request-fields

We need to add a new field here:

Field Data type Description
SEGMENT_REPLICATION_INDEXING_PRESSURE_ENABLED Boolean Enables the segment replication backpressure mechanism. Default is false.
MAX_REPLICATION_TIME_BACKPRESSURE_SETTING Time unit The maximum amount of time that a replica shard can take to copy from the primary shard. Once MAX_REPLICATION_TIME_BACKPRESSURE_SETTING is breached along with MAX_INDEXING_CHECKPOINTS, the segment replication backpressure mechanism is initiated on primary. Default is 5 minutes.
MAX_REPLICATION_LIMIT_STALE_REPLICA_SETTING Time Unit The maximum amount of time that a replica shard can take to copy from the primary shard. Once MAX_REPLICATION_LIMIT_STALE_REPLICA_SETTING is breached, we start failing the replica shard. Default is 0 minutes(disabled).
MAX_INDEXING_CHECKPOINTS Integer The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once MAX_INDEXING_CHECKPOINTS is breached along with MAX_REPLICATION_TIME_BACKPRESSURE_SETTING, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints.
MAX_ALLOWED_STALE_SHARDS Floating point The maximum number of stale replica shards that can exist in a replication group. Once MAX_ALLOWED_STALE_SHARDS is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
opensearch-project/OpenSearch#9507
opensearch-project/OpenSearch#8453

@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started backport 2.9 PR: Backport label for 2.9 and removed untriaged labels Sep 25, 2023
@Naarcha-AWS Naarcha-AWS self-assigned this Sep 25, 2023
@Naarcha-AWS Naarcha-AWS added v2.10.0 2 - In progress Issue/PR: The issue or PR is in progress. and removed backport 2.9 PR: Backport label for 2.9 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Sep 25, 2023
@Naarcha-AWS Naarcha-AWS added this to the v2.10 milestone Sep 25, 2023
@hdhalter
Copy link
Collaborator

@Naarcha-AWS - Is this complete? Can we close?

@hdhalter
Copy link
Collaborator

hdhalter commented Dec 5, 2023

@Naarcha-AWS - It doesn't look like this was done in 2.10. Can we get these added? Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. v2.10.0
Projects
None yet
Development

No branches or pull requests

3 participants