summaryrefslogtreecommitdiff
path: root/docs/rabbitmqctl.1.xml
diff options
context:
space:
mode:
authorMatthias Radestock <matthias@rabbitmq.com>2011-09-14 20:27:23 +0100
committerMatthias Radestock <matthias@rabbitmq.com>2011-09-14 20:27:23 +0100
commit93dd7f01ee89c6b6f2b8e83ec83461573bb8bf83 (patch)
treef2a6fd2da958fc5737ff9534af4029734267b590 /docs/rabbitmqctl.1.xml
parentfacffae7b771325bdf7094043047fc5226d1be88 (diff)
downloadrabbitmq-server-git-93dd7f01ee89c6b6f2b8e83ec83461573bb8bf83.tar.gz
improve 'rabbitmqctl rotate_logs' docs
Diffstat (limited to 'docs/rabbitmqctl.1.xml')
-rw-r--r--docs/rabbitmqctl.1.xml33
1 files changed, 16 insertions, 17 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index 3291c44d37..1f8cf28eb9 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -251,29 +251,28 @@
Instruct the RabbitMQ node to rotate the log files.
</para>
<para>
- The RabbitMQ broker will attempt to append the current contents
- of the log file to the file with name composed of the original
- name and the suffix.
- It will create a new file if such a file does not already exist.
- When no <option>suffix</option> is specified, the empty log file is
- simply created at the original location; no rotation takes place.
+ The RabbitMQ broker appends the contents of its log
+ files to files with names composed of the original name
+ and the suffix, and then resumes logging to freshly
+ created files at the original location. I.e. effectively
+ the current log contents are moved to the end of the
+ suffixed files.
</para>
<para>
- When an error occurs while appending the contents of the old log
- file, the operation behaves in the same way as if no <option>suffix</option> was
- specified.
- </para>
- <para>
- This command might be helpful when you are e.g. writing your
- own logrotate script and you do not want to restart the RabbitMQ
- node.
+ When the target files do not exist they are created.
+ target files do not already exist. When
+ no <option>suffix</option> is specified, the empty log
+ files are simply created at the original location; no
+ rotation takes place.
</para>
<para role="example-prefix">For example:</para>
<screen role="example">rabbitmqctl rotate_logs .1</screen>
<para role="example">
- This command instructs the RabbitMQ node to append the current content
- of the log files to the files with names consisting of the original logs'
- names and ".1" suffix, e.g. rabbit.log.1. Finally, the old log files are reopened.
+ This command instructs the RabbitMQ node to append the contents
+ of the log files to files with names consisting of the original logs'
+ names and ".1" suffix, e.g. rabbit@mymachine.log.1 and
+ rabbit@mymachine-sasl.log.1. Finally, logging resumes to
+ fresh files at the old locations.
</para>
</listitem>
</varlistentry>