[DOC-13921]: XDCR: Tuners to Throttle DCP Control Flow & Async Events Channel Length#4107
Open
RayOffiah wants to merge 4 commits intorelease/8.1from
Conversation
… Channel Length Documented XDCR settings for throttling DCP control flow and asynchronous event channel length. Added new reference page and updated navigation. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>
There was a problem hiding this comment.
Pull request overview
Adds documentation for new XDCR advanced settings (Couchbase Server 8.1) aimed at lowering XDCR’s memory footprint by throttling DCP control flow and tuning internal async event buffering.
Changes:
- Adds a new XDCR reference page explaining
dcpFlowControlThrottleandcomponentEventsChanLength, plus monitoring guidance. - Updates the XDCR advanced settings REST API reference to include the new settings and show them in the sample response payload.
- Updates site navigation to link to the new reference page.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| modules/xdcr-reference/pages/xdcr-lowering-memory-footprint.adoc | New reference content describing the two new memory-footprint-related tunables and how to monitor throttled replications. |
| modules/rest-api/pages/rest-xdcr-adv-settings.adoc | Documents the new advanced settings and updates the example response payload and settings table. |
| modules/ROOT/nav.adoc | Adds a nav entry pointing readers to the new XDCR memory footprint page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of Changes
Documented new XDCR settings for:
Changes include adding a new reference page and updating the navigation structure.
Preview URLs:
https://preview.docs-test.couchbase.com/docs-server-DOC-13921--XDCR-Tuners-to-Throttle-DCP-Control-Flow--Async-Events-Channel-Length/server/current/xdcr-reference/xdcr-lowering-memory-footprint.html
https://preview.docs-test.couchbase.com/docs-server-DOC-13921--XDCR-Tuners-to-Throttle-DCP-Control-Flow--Async-Events-Channel-Length/server/current/rest-api/rest-xdcr-adv-settings.html
You will need the Docs Team credentials on Confluence.