Merge pull request #1252 from FabianPonce/fix-gc-docs

Improve documentation around new default for background garbage collection

Author: michaelklishin

docs/rabbitmq.conf.example

@@ -386,7 +386,7 @@
 ## Disabling background GC may reduce latency for client operations,
 ## keeping it enabled may reduce median RAM usage.
 ##
-# background_gc_enabled = true
+# background_gc_enabled = false
 
 ## Target (desired) interval (in milliseconds) at which we run background GC.
 ## The actual interval will vary depending on how long it takes to execute

docs/rabbitmq.config.example

@@ -276,7 +276,7 @@
    %% See http://www.rabbitmq.com/partitions.html for further details.
    %%
    %% {cluster_partition_handling, ignore},
-   
+
    %% Mirror sync batch size, in messages. Increasing this will speed
    %% up syncing but total batch size in bytes must not exceed 2 GiB.
    %% Available in RabbitMQ 3.6.0 or later.
@@ -343,7 +343,7 @@
    %% Disabling background GC may reduce latency for client operations,
    %% keeping it enabled may reduce median RAM usage.
    %%
-   %% {background_gc_enabled, true},
+   %% {background_gc_enabled, false},
    %%
    %% Target (desired) interval (in milliseconds) at which we run background GC.
    %% The actual interval will vary depending on how long it takes to execute

src/background_gc.erl

@@ -74,7 +74,7 @@ interval_gc(State = #state{last_interval = LastInterval}) ->
     State#state{last_interval = Interval}.
 
 gc() ->
-    Enabled = rabbit_misc:get_env(rabbit, background_gc_enabled, true),
+    Enabled = rabbit_misc:get_env(rabbit, background_gc_enabled, false),
     case Enabled of
         true ->
             [garbage_collect(P) || P <- processes(),