Skip to content
This repository was archived by the owner on Oct 17, 2022. It is now read-only.

Update configuration of compaction daemon#386

Merged
wohali merged 3 commits intoapache:masterfrom
adrienverge:docs/update-configuration-of-compaction-daemon
Jan 31, 2019
Merged

Update configuration of compaction daemon#386
wohali merged 3 commits intoapache:masterfrom
adrienverge:docs/update-configuration-of-compaction-daemon

Conversation

@adrienverge
Copy link
Copy Markdown
Contributor

@adrienverge adrienverge commented Jan 28, 2019

Fix default check_interval value in compaction docs

Since apache/couchdb@58fef34 "feat: bump the compaction daemon
check_interval to one hour", the default value is 3600.


Try to make check_interval explanation clearer

We had a hard time finding whether check_interval was waited between
each database compaction, or between a whole compaction run for all
databases
.

I propose to make it very explicit.


Add missing snooze_period_ms in compaction docs

This new parameter was introduced in apache/couchdb@e5bf9d4 "add
snooze_period doc to default.ini" and changed in apache/couchdb@5471694
"Add snooze_period_ms for finer tuning".

Since apache/couchdb@58fef34 "feat: bump the compaction daemon
check_interval to one hour", the default value is `3600`.
@adrienverge
Copy link
Copy Markdown
Contributor Author

I just updated the third commit to take the merge of apache/couchdb#1880 into account:

--- a/src/config/compaction.rst
+++ b/src/config/compaction.rst
@@ -172,16 +172,19 @@ Configuration of Compaction Daemon
             [compaction_daemon]
             min_file_size = 131072
 
-    .. config:option:: snooze_period
+    .. config:option:: snooze_period_ms
 
         With lots of databases and/or with lots of design docs in one or more
         databases, the compaction_daemon can create significant CPU load when
         checking whether databases and view indexes need compacting. The
-        snooze_period setting ensures a smoother CPU load. Defaults to
-        3 seconds wait.
+        ``snooze_period_ms`` setting ensures a smoother CPU load. Defaults to
+        3000 milliseconds wait. Note that this option was formerly called
+        ``snooze_period``, measured in seconds (it is currently still
+        supported).
 
             [compaction_daemon]
-            snooze_period = 3
+            snooze_period_ms = 3000
+
 
 .. _config/view_compaction:

@jiangphcn
Copy link
Copy Markdown
Contributor

just double check, the default for snooze_period_ms is 3600 instead of 3000?

@adrienverge
Copy link
Copy Markdown
Contributor Author

No the default is 3000 milliseconds (i.e. 3 seconds).

@jiangphcn
Copy link
Copy Markdown
Contributor

@adrienverge adrienverge force-pushed the docs/update-configuration-of-compaction-daemon branch 2 times, most recently from 5a90d09 to 6fae214 Compare January 31, 2019 08:53
@adrienverge
Copy link
Copy Markdown
Contributor Author

I pasted the diff but forgot to push... sorry about that and thanks for telling me!

@jiangphcn
Copy link
Copy Markdown
Contributor

Cool. There is one failure from travis. Could you please check?

@adrienverge adrienverge force-pushed the docs/update-configuration-of-compaction-daemon branch from 6fae214 to 381cb38 Compare January 31, 2019 10:40
@adrienverge
Copy link
Copy Markdown
Contributor Author

Sure, done!

Copy link
Copy Markdown
Member

@wohali wohali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with minor changes, please revise

Comment thread src/config/compaction.rst Outdated
Comment thread src/config/compaction.rst Outdated
We had a hard time finding whether `check_interval` was waited between
*each database compaction*, or between *a whole compaction run for all
databases*.

I propose to make it very explicit.
This new parameter was introduced in apache/couchdb@e5bf9d4 "add
snooze_period doc to default.ini" and changed in apache/couchdb@5471694
"Add snooze_period_ms for finer tuning".
@adrienverge adrienverge force-pushed the docs/update-configuration-of-compaction-daemon branch from 381cb38 to 3ab5ac4 Compare January 31, 2019 18:05
@adrienverge
Copy link
Copy Markdown
Contributor Author

Updated:

--- a/src/config/compaction.rst
+++ b/src/config/compaction.rst
@@ -157,7 +157,7 @@ Configuration of Compaction Daemon
     .. config:option:: check_interval
 
         The delay, in seconds, between each check for which database and view
-        indexes need to be compacted. In other words, this delay will be waited
+        indexes need to be compacted. In other words, this delay will occur
         after *all* databases and views are compacted (or at least checked)::
 
             [compaction_daemon]
@@ -178,9 +178,7 @@ Configuration of Compaction Daemon
         databases, the compaction_daemon can create significant CPU load when
         checking whether databases and view indexes need compacting. The
         ``snooze_period_ms`` setting ensures a smoother CPU load. Defaults to
-        3000 milliseconds wait. Note that this option was formerly called
-        ``snooze_period``, measured in seconds (it is currently still
-        supported).
+        3000 milliseconds wait.
 
             [compaction_daemon]
             snooze_period_ms = 3000

@wohali wohali merged commit eaf572f into apache:master Jan 31, 2019
@wohali
Copy link
Copy Markdown
Member

wohali commented Jan 31, 2019

Thanks @adrienverge !

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants