-
Notifications
You must be signed in to change notification settings - Fork 182
DOC-13648 document magma flusher threads 7.6 #4079
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
base: release/7.6
Are you sure you want to change the base?
DOC-13648 document magma flusher threads 7.6 #4079
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds documentation for Magma flusher thread settings introduced in Couchbase Server 7.6.10, enabling administrators to configure thread allocation for Magma storage engine operations.
Changes:
- Added documentation for
magma_max_default_storage_threadsandmagma_flusher_thread_percentagesettings - Enhanced REST API documentation with GET endpoint and comprehensive parameter descriptions
- Created reusable partial for common API parameters
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 12 comments.
| File | Description |
|---|---|
| modules/rest-api/partials/user_pwd_host_port_params.adoc | New reusable partial defining standard REST API authentication and connection parameters |
| modules/rest-api/pages/rest-reader-writer-thread-config.adoc | Major expansion adding GET endpoint documentation and two new Magma thread configuration parameters |
| modules/learn/pages/buckets-memory-and-storage/storage-settings.adoc | New section documenting Magma flushing and compaction thread behavior and monitoring guidance |
| modules/learn/pages/buckets-memory-and-storage/storage-engines.adoc | Updated to reference new Magma thread tuning capabilities |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,15 @@ | |||
| // Be sure to set the 'required-priviledges' attribute before including this partial. | |||
Copilot
AI
Jan 27, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Corrected spelling of 'priviledges' to 'privileges'.
|
|
||
| `USER`:: | ||
|
|
||
| The name of a user who has at least 1 of the roles listed in xref:{required-priviledges}[Required Privileges]. |
Copilot
AI
Jan 27, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Corrected spelling of 'priviledges' to 'privileges'.
| [#threading] | ||
| == Threading | ||
|
|
||
| Couchbase Server uses multiple threads when reading an writing data. |
Copilot
AI
Jan 27, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Corrected 'an' to 'and' before 'writing'.
| Couchbase Server uses multiple threads when reading an writing data. | |
| Couchbase Server uses multiple threads when reading and writing data. |
modules/learn/pages/buckets-memory-and-storage/storage-settings.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/buckets-memory-and-storage/storage-engines.adoc
Outdated
Show resolved
Hide resolved
|
We identified that we mistakenly added magma_max_default_storage_threads which is a duplicate of existing num_storage_threads setting. MB-70349 is opened to remove this parameter. Could you please wait until MB-70349 changes are merged? We have to rename magma_max_default_storage_threads back to num_storage_threads. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Adds documentation for the Magma flusher settings to Couchbase 7.6.10.
The following changes link to a preview site. You will need the Docs Team credentials on Confluence.
Note: I've not added any sort of "What's New" entry for these settings because I don't think we want to call that much attention to them. Let me know if we should add some sort of announcement there.