ctdb-logging: Add non-blocking Unix domain logging to syslog backend

[samba.git] / ctdb / doc / ctdbd.1.xml

diff --git a/ctdb/doc/ctdbd.1.xml b/ctdb/doc/ctdbd.1.xml
index e700bf293ee8190da620fe7564fdee4b12abdb79..fdf03d1e3a0d80a4f60d88616d8cd1a8d723d676 100644 (file)
--- a/ctdb/doc/ctdbd.1.xml
+++ b/ctdb/doc/ctdbd.1.xml
@@ -150,11 +150,36 @@
              </listitem>
            </varlistentry>
            <varlistentry>
-             <term>syslog</term>
-             <listitem>
+             <term>syslog<optional>:<parameter>METHOD</parameter></optional></term>
+              <listitem>
+                <para>
+                 CTDB will log to syslog.  By default this will use
+                 the syslog(3) API.
+                </para>
+               <para>
+                 Under heavy loads syslog(3) can block if the syslog
+                 daemon processes messages too slowly.  This can
+                 cause CTDB to block when logging.
+               </para>
                <para>
-                 CTDB will log to syslog
+                 If METHOD is specified then it specifies an
+                 extension that causes logging to be done in a
+                 non-blocking mode.  Note that <emphasis>this may
+                 cause messages to be dropped</emphasis>.  METHOD
+                 must be one of:
                </para>
+               <variablelist>
+                 <varlistentry>
+                   <term>nonblocking</term>
+                   <listitem>
+                     <para>
+                       CTDB will log to syslog via
+                       <filename>/dev/log</filename> in non-blocking
+                       mode.
+                     </para>
+                   </listitem>
+                 </varlistentry>
+               </variablelist>
              </listitem>
            </varlistentry>
          </variablelist>