summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael Klishin <mklishin@pivotal.io>2018-03-21 10:07:07 +0300
committerMichael Klishin <mklishin@pivotal.io>2018-03-21 10:08:13 +0300
commit5f7b7cd66b9c0274e7b0b52494f320da7b5798fb (patch)
tree0a53177f2c4c707cbcb0d634c779988f063836c8 /docs
parent4f3131053eb80d11787c4772e421507a653354cc (diff)
downloadrabbitmq-server-git-5f7b7cd66b9c0274e7b0b52494f320da7b5798fb.tar.gz
Improve background_gc docs in example config files
To make it clearer that memory breakdown analysis must be done formed. "Don't guess, collect data". (cherry picked from commit bb36e18a0ab25117ca8ccf3aecd58bdd3985006b)
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmq.conf.example10
-rw-r--r--docs/rabbitmq.config.example10
2 files changed, 16 insertions, 4 deletions
diff --git a/docs/rabbitmq.conf.example b/docs/rabbitmq.conf.example
index c0ef61fac1..39722505f9 100644
--- a/docs/rabbitmq.conf.example
+++ b/docs/rabbitmq.conf.example
@@ -424,11 +424,15 @@
##
# queue_index_embed_msgs_below = 4kb
-## Whether or not to enable background periodic GC of all
-## Erlang processes in "waiting" state.
+## Whether or not to enable background periodic forced GC runs for all
+## Erlang processes on the node in "waiting" state.
##
## Disabling background GC may reduce latency for client operations,
-## keeping it enabled may reduce median RAM usage.
+## keeping it enabled may reduce median RAM usage by the binary heap
+## (see https://www.erlang-solutions.com/blog/erlang-garbage-collector.html).
+##
+## Before trying this option, please take a look at the memory
+## breakdown (http://www.rabbitmq.com/memory-use.html).
##
# background_gc_enabled = false
diff --git a/docs/rabbitmq.config.example b/docs/rabbitmq.config.example
index 3d41ae138c..9ee9a352be 100644
--- a/docs/rabbitmq.config.example
+++ b/docs/rabbitmq.config.example
@@ -471,7 +471,15 @@
%%
%% {disk_monitor_failure_retry_interval, 120000},
- %% Whether or not to enable background GC.
+ %% Whether or not to enable background periodic forced GC runs for all
+ %% Erlang processes on the node in "waiting" state.
+ %%
+ %% Disabling background GC may reduce latency for client operations,
+ %% keeping it enabled may reduce median RAM usage by the binary heap
+ %% (see https://www.erlang-solutions.com/blog/erlang-garbage-collector.html).
+ %%
+ %% Before enabling this option, please take a look at the memory
+ %% breakdown (http://www.rabbitmq.com/memory-use.html).
%%
%% {background_gc_enabled, false},