Skip to content

Commit a31bb2e

Browse files
Be more elaborate in background GC config example
1 parent 51b4069 commit a31bb2e

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

docs/rabbitmq.conf.example

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -380,11 +380,18 @@
380380
##
381381
# queue_index_embed_msgs_below = 4kb
382382

383-
## Whether or not to enable background GC.
383+
## Whether or not to enable background periodic GC of all
384+
## Erlang processes in "waiting" state.
385+
##
386+
## Disabling background GC may reduce latency for client operations,
387+
## keeping it enabled may reduce median RAM usage.
384388
##
385389
# background_gc_enabled = true
386390

387-
## Interval (in milliseconds) at which we run background GC.
391+
## Target (desired) interval (in milliseconds) at which we run background GC.
392+
## The actual interval will vary depending on how long it takes to execute
393+
## the operation (can be higher than this interval). Values less than
394+
## 30000 milliseconds are not recommended.
388395
##
389396
# background_gc_target_interval = 60000
390397

@@ -623,7 +630,7 @@
623630

624631
## File rotation config. No rotation by defualt.
625632
## DO NOT SET rotation date to ''. Leave unset if require "" value
626-
# log.file.rotation.date = $D0
633+
# log.file.rotation.date = $D0
627634
# log.file.rotation.size = 0
628635

629636

docs/rabbitmq.config.example

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -333,11 +333,18 @@
333333
%%
334334
%% {queue_index_embed_msgs_below, 4096},
335335

336-
%% Whether or not to enable background GC.
336+
%% Whether or not to enable background periodic GC of all
337+
%% Erlang processes in "waiting" state.
338+
%%
339+
%% Disabling background GC may reduce latency for client operations,
340+
%% keeping it enabled may reduce median RAM usage.
337341
%%
338342
%% {background_gc_enabled, true},
339343
%%
340-
%% Interval (in milliseconds) at which we run background GC.
344+
%% Target (desired) interval (in milliseconds) at which we run background GC.
345+
%% The actual interval will vary depending on how long it takes to execute
346+
%% the operation (can be higher than this interval). Values less than
347+
%% 30000 milliseconds are not recommended.
341348
%%
342349
%% {background_gc_target_interval, 60000}
343350

0 commit comments

Comments
 (0)