Skip to content

Commit bb36e18

Browse files
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".
1 parent 2ae6ba6 commit bb36e18

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/rabbitmq.conf.example

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -424,11 +424,15 @@
424424
##
425425
# queue_index_embed_msgs_below = 4kb
426426

427-
## Whether or not to enable background periodic GC of all
428-
## Erlang processes in "waiting" state.
427+
## Whether or not to enable background periodic forced GC runs for all
428+
## Erlang processes on the node in "waiting" state.
429429
##
430430
## Disabling background GC may reduce latency for client operations,
431-
## keeping it enabled may reduce median RAM usage.
431+
## keeping it enabled may reduce median RAM usage by the binary heap
432+
## (see https://www.erlang-solutions.com/blog/erlang-garbage-collector.html).
433+
##
434+
## Before trying this option, please take a look at the memory
435+
## breakdown (http://www.rabbitmq.com/memory-use.html).
432436
##
433437
# background_gc_enabled = false
434438

docs/rabbitmq.config.example

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,15 @@
471471
%%
472472
%% {disk_monitor_failure_retry_interval, 120000},
473473

474-
%% Whether or not to enable background GC.
474+
%% Whether or not to enable background periodic forced GC runs for all
475+
%% Erlang processes on the node in "waiting" state.
476+
%%
477+
%% Disabling background GC may reduce latency for client operations,
478+
%% keeping it enabled may reduce median RAM usage by the binary heap
479+
%% (see https://www.erlang-solutions.com/blog/erlang-garbage-collector.html).
480+
%%
481+
%% Before enabling this option, please take a look at the memory
482+
%% breakdown (http://www.rabbitmq.com/memory-use.html).
475483
%%
476484
%% {background_gc_enabled, false},
477485

0 commit comments

Comments
 (0)