diff options
| author | Emile Joubert <emile@rabbitmq.com> | 2011-08-17 12:25:14 +0100 |
|---|---|---|
| committer | Emile Joubert <emile@rabbitmq.com> | 2011-08-17 12:25:14 +0100 |
| commit | 1939ebd315d384336bd6e6dba8f78b5b4a8a7a91 (patch) | |
| tree | 761c24a673df02e9fd17913e557dc0d4f47c5ba3 /docs | |
| parent | 9c02129120b895b43ee51b483dae56203662ad23 (diff) | |
| download | rabbitmq-server-git-1939ebd315d384336bd6e6dba8f78b5b4a8a7a91.tar.gz | |
Change vm_memory_high_watermark while running
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index ba87c83648..c506ad87dd 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -1296,7 +1296,7 @@ <para> Displays broker status information such as the running applications on the current Erlang node, RabbitMQ and - Erlang versions and OS name. (See + Erlang versions, OS name and memory statistics. (See the <command>cluster_status</command> command to find out which nodes are clustered and running.) </para> @@ -1373,7 +1373,37 @@ </para> </listitem> </varlistentry> + </variablelist> + </refsect2> + <refsect2> + <title>Memory Management</title> + <variablelist> + + <varlistentry> + <term><cmdsynopsis><command>set_vm_memory_high_watermark</command> <arg choice="req"><replaceable>fraction</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>fraction</term> + <listitem><para>The new memory threshhold fraction as a floating point number between + 0.0 and 1.0 . The fractional part is compulsory.</para></listitem> + </varlistentry> + </variablelist> + <para> + Sets the memory threshhold fraction at which memory-based flow control is + triggered, until the broker restarts. This command is intended for use in + systems that support hot-swappable RAM. The corresponding configuration + setting should also be changed when the effects of this command should + survive a broker restart. Use the <command>status</command> command to + confirm the currently active threshhold. + </para> + <screen role="example">rabbitmqctl set_vm_memory_high_watermark 0.4</screen> + <para role="example"> + This command sets the memory threshhold fraction to the default value of 40%. + </para> + </listitem> + </varlistentry> </variablelist> </refsect2> </refsect1> |