Skip to content

Conversation

@ggray-cb
Copy link
Contributor

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.

  • Added Magma Flushing and Compaction Threads to provide an overview of the settings. Also added a subsection above this to cover the existing description of reader and writer threads
  • Added the new parameters to the Setting Thread Allocations REST API documentation. Also added missing sections to this documentation (such as the GET REST API method which wasn't there before).

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.

Copy link

Copilot AI left a 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_threads and magma_flusher_thread_percentage settings
  • 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.
Copy link

Copilot AI Jan 27, 2026

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'.

Copilot uses AI. Check for mistakes.

`USER`::

The name of a user who has at least 1 of the roles listed in xref:{required-priviledges}[Required Privileges].
Copy link

Copilot AI Jan 27, 2026

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'.

Copilot uses AI. Check for mistakes.
[#threading]
== Threading

Couchbase Server uses multiple threads when reading an writing data.
Copy link

Copilot AI Jan 27, 2026

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'.

Suggested change
Couchbase Server uses multiple threads when reading an writing data.
Couchbase Server uses multiple threads when reading and writing data.

Copilot uses AI. Check for mistakes.
@t3rm1n4l
Copy link

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.

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.

3 participants