summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniil Fedotov <dfedotov@pivotal.io>2015-12-02 14:59:27 +0000
committerDaniil Fedotov <dfedotov@pivotal.io>2015-12-02 14:59:27 +0000
commit99d2e486179137d2b4e51df76beedad73032bb36 (patch)
treeb3f27f8849e3b229187f5ffc08f1155b891bf607 /docs
parent92a3cd890fd4f5b506e496f429d90b2048bb5c7a (diff)
downloadrabbitmq-server-git-99d2e486179137d2b4e51df76beedad73032bb36.tar.gz
Support setting vm_memory_high_watermark and disk_free_limit in memory units
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmq.config.example16
-rw-r--r--docs/rabbitmqctl.1.xml13
2 files changed, 26 insertions, 3 deletions
diff --git a/docs/rabbitmq.config.example b/docs/rabbitmq.config.example
index 13cac251e6..d555507e31 100644
--- a/docs/rabbitmq.config.example
+++ b/docs/rabbitmq.config.example
@@ -193,6 +193,18 @@
%% Alternatively, we can set a limit (in bytes) of RAM used by the node.
%%
%% {vm_memory_high_watermark, {absolute, 1073741824}},
+ %%
+ %% Or you can set absolute value using memory units.
+ %%
+ %% {vm_memory_high_watermark, {absolute, "1024MB"}},
+ %%
+ %% Memory units rules:
+ %% k, kiB - kibibytes (2^10)
+ %% M, MiB - mebibytes (2^20)
+ %% G, GiB - gibibytes (2^30)
+ %% kB - kilobytes (10^3)
+ %% MB - megabytes (10^6)
+ %% GB - gigabytes (10^9)
%% Fraction of the high watermark limit at which queues start to
%% page message out to disc in order to free up memory.
@@ -211,6 +223,10 @@
%% listed above for more details.
%%
%% {disk_free_limit, 50000000},
+ %%
+ %% Or you can set it using memory units (same as in vm_memory_high_watermark)
+ %% {disk_free_limit, "50MB"},
+ %% {disk_free_limit, "50000kB"},
%% Alternatively, we can set a limit relative to total available RAM.
%%
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index 885e3c4dd2..ee34b15517 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -1958,15 +1958,22 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><cmdsynopsis><command>set_vm_memory_high_watermark absolute</command> <arg choice="req"><replaceable>memory_limit_in_bytes</replaceable></arg></cmdsynopsis></term>
+ <term><cmdsynopsis><command>set_vm_memory_high_watermark absolute</command> <arg choice="req"><replaceable>memory_limit</replaceable></arg></cmdsynopsis></term>
<listitem>
<variablelist>
<varlistentry>
- <term>memory_limit_in_bytes</term>
+ <term>memory_limit</term>
<listitem><para>
The new memory limit at which flow control is
triggered, expressed in bytes as an integer number
- greater than or equal to 0.
+ greater than or equal to 0 or as string with memory unit
+ (e.g. 1024MB). Available units are:
+ k, kiB - kibibytes (2^10)
+ M, MiB - mebibytes (2^20)
+ G, GiB - gibibytes (2^30)
+ kB - kilobytes (10^3)
+ MB - megabytes (10^6)
+ GB - gigabytes (10^9)
</para></listitem>
</varlistentry>
</variablelist>