Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
f43cbb7
In-progress checkin.
ggray-cb Nov 26, 2025
326a32a
Done with draft
ggray-cb Dec 2, 2025
8c675dc
Adjusted the in-page TOC level
ggray-cb Dec 2, 2025
5a474b3
Added anchors for some links
ggray-cb Dec 2, 2025
347cc9f
Fixing numbered list
ggray-cb Dec 3, 2025
68f1bc1
Fixing typos spotted by Hyun-Ju
ggray-cb Dec 10, 2025
70267a2
* Deleting commented-out content because the new version has been app…
ggray-cb Dec 10, 2025
9e00e2a
Add warning for modifying services (#3966)
rao-shwe Nov 14, 2025
a349e24
lowered thresholds (#3968)
TimLFletcher Nov 19, 2025
e56a136
Doc 12634 (#3959)
TimLFletcher Nov 19, 2025
1c566aa
Update cbstats warmup content with bucket data (#3981)
rao-shwe Nov 25, 2025
665dcc3
DOC-12197 Added non-encoded example (#3974)
TimLFletcher Nov 25, 2025
4fa5316
DOC-12563 fixed mcstat info (#3986)
TimLFletcher Nov 25, 2025
9fabd1c
DOC-13126-Incorrect-list-of-values-for-"operator"-in-Getting-Multiple…
supritha-kumar Nov 26, 2025
c0b04a9
DOC-13754 non-version the SDK link
RichardSmedley Nov 26, 2025
79bceda
DOC-13744: Remove 8092, 18092 ports association with XDCR (#3991)
hyunjuV Nov 26, 2025
c212355
DOC-13744: Update install-ports.adoc -- remove XDCR, capi association…
hyunjuV Nov 26, 2025
57259ac
DOC-13329: Clearer commands and descriptions for timeout (#4000)
simon-dew Nov 28, 2025
5dd11b6
[DOC-12349] Update Query Execution Diagram (#3962)
rakhi-prathap Nov 28, 2025
72f28e6
DOC-13756: Minor doc fixes (#4002)
simon-dew Nov 28, 2025
8c810c7
Merge pull request #4006
RayOffiah Dec 1, 2025
b5453f6
Merge pull request #4003
RayOffiah Dec 2, 2025
4771216
[DOC-13654]: Update Release Notes Documentation page with MB-62678 (#…
RayOffiah Dec 3, 2025
676a2ec
[DOC-12426] Search Facets (#4008)
sarahlwelton Dec 3, 2025
d75de64
DOC-12198-Feedback on Initializing a Node (#3994)
supritha-kumar Dec 4, 2025
d281c7d
Update rest-set-password-policy.adoc (#4009)
supritha-kumar Dec 4, 2025
f8d5f96
DOC-13735-Feedback on Couchbase Server Ports (#4013)
supritha-kumar Dec 4, 2025
35ff35c
Updated checkpoint parameters (#4031)
rao-shwe Dec 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 19 additions & 14 deletions modules/cli/pages/cbepctl/set-checkpoint_param.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ cbepctl [host]:11210 -b [bucket-name] set checkpoint_param [parameter] [value]

== Description

This command configures a checkpoint.
This command changes checkpoint configuration parameters.

== Options

Expand All @@ -26,22 +26,27 @@ The following are the command options:
|===
| Options | Description

| `chk_max_items`
| Max number of items allowed in a checkpoint.
| `max_checkpoints`
| The expected maximum number of checkpoints in each vBucket on a balanced system.

| `chk_period`
| Time bound (in sec.) on a checkpoint.
NOTE: This value does not act as a hard limit for a single vBucket.
The system uses it along with `checkpoint_memory_ratio` to compute `checkpoint_max_size`, which triggers checkpoint creation.

| `item_num_based_new_chk`
| True if a new checkpoint can be created based on.
The number of items in the open checkpoint.
| `checkpoint_memory_ratio`
| Maximum portion of the bucket quota that the system can allocate to checkpoints.

| `keep_closed_chks`
| True if we want to keep closed checkpoints in memory, as long as the current memory usage is below high water mark.
| `checkpoint_memory_recovery_upper_mark`
| Fraction of the checkpoint quota computed by `checkpoint_memory_ratio` that triggers an attempt to release memory from checkpoints.

| `max_checkpoints`
| Max number of checkpoints allowed per vBucket.
| `checkpoint_memory_recovery_lower_mark`
| Fraction of the checkpoint quota computed by `checkpoint_memory_ratio` that represents the target for checkpoint memory recovery.
Memory recovery stops when this target is reached.

| `checkpoint_max_size`
| Maximum size in bytes of a single checkpoint.
Use `0` to allow ep-engine to configure this value automatically.

| `checkpoint_destruction_tasks`
| Number of background tasks that destroy closed and unreferenced checkpoints to free memory.

| `enable_chk_merge`
| True, if merging closed checkpoints is enabled.
|===
51 changes: 22 additions & 29 deletions modules/cli/pages/cbstats/cbstats-warmup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
The basic syntax is:

----
cbstats [host]:[dataport] -b [bucket_name] -p [bucket_password] raw warmup
cbstats [host]:[dataport] -b [bucket_name] -p [bucket_password] warmup
----

== Description
Expand Down Expand Up @@ -47,36 +47,28 @@ Look for values: loading keys, loading access log, and done.
| Number of failures due to duplicate keys.
| Integer

| ep_warmup_estimate_time
| The time taken, measured in milliseconds, to discover the estimated number of keys that may be warmed up.
| Integer.

| ep_warmup_estimated_key_count
| The estimated number of keys in database.
| Integer.
Default: unknown

| ep_warmup_estimate_time
| Thne estimated time in microseconds to do warmup.
| Integer.

| ep_warmup_estimated_value_count
| The estimated number of key data to read based on the access log.
| Integer.
Default: unknown

| ep_warmup_keys_count
| ep_warmup_key_count
| Number of keys warmed up.
| Integer

| ep_warmup_keys_time
| Total time (in microseconds) spent by loading persisted keys.
| Integer

| ep_warmup_min_items_threshold
| Enable data traffic after loading this percentage of key data.
| Integer

| ep_warmup_min_memory_threshold
| Enable data traffic after filling this % of memory.
| Integer (%)

| ep_warmup_oom
| Number of out of memory failures during warmup.
| Integer
Expand Down Expand Up @@ -119,26 +111,27 @@ The following are the command options:
*Request*

----
cbstats 10.5.2.117:11210 warmup
cbstats localhost:11210 warmup \
-u Administrator \
-p password \
-b travel-sample
----

*Response*

Example response:

----
ep_warmup: enabled
ep_warmup_dups: 0
ep_warmup_estimate_time: 57546
ep_warmup_estimated_key_count: 0
ep_warmup_estimated_value_count: unknown
ep_warmup_key_count: 0
ep_warmup_keys_time: 529022
ep_warmup_min_items_threshold: 100
ep_warmup_min_memory_threshold: 100
ep_warmup_oom: 0
ep_warmup_state: done
ep_warmup_thread: complete
ep_warmup_time: 529192
ep_warmup_value_count: 0
ep_warmup: enabled
ep_warmup_dups: 0
ep_warmup_estimate_time: 8159
ep_warmup_estimated_key_count: 63325
ep_warmup_estimated_value_count: unknown
ep_warmup_key_count: 63325
ep_warmup_keys_time: 199582
ep_warmup_oom: 0
ep_warmup_state: done
ep_warmup_thread: complete
ep_warmup_time: 199586
ep_warmup_value_count: 63325
----
10 changes: 2 additions & 8 deletions modules/cli/pages/mcstat.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
= mcstat
:description: pass:q[The `mcstat` tool provides memory-related information for a specified bucket, or for all buckets on a cluster.]
:description: pass:q[The mcstat tool provides detailed information for a node, specified bucket, or for all buckets on a cluster.]
:page-topic-type: reference
:page-aliases: cli:cbstats/cbstats-allocator

[abstract]
{description}

== Description

The `mcstat` tool provides memory-related information for a specified bucket, or for all buckets on a cluster.

The tool is located as follows:

[cols="2,3"]
Expand Down Expand Up @@ -40,9 +36,7 @@ The `options` are as follows:
| Options | Description

| `-h[=statkey]`or `--help[=statkey]`
| Show the help message and exit.
If `=statkey` is not specified, the common options for the command are listed.
If `=statkey` _is_ specified, the available _statkeys_ for the command are listed instead.
| Outputs possible `statkey` values with descriptions and indications of the stat's scope and required privileges.

| `-h` or `--hostname`, with the parameter `<hostname[:port]>` (for IPv4), or `[address]:port` (for IPv6)
| The name of the host (and optionally, the port number) to connect to.
Expand Down
192 changes: 0 additions & 192 deletions modules/fts/pages/fts-search-facets.adoc

This file was deleted.

Loading