[Supervisor-checkins] r857 - supervisor_manual/trunk/chapters

[Mike Naberezny]

Author: Mike Naberezny <mike at maintainable.com>
Date: Fri May 22 18:19:37 2009
New Revision: 857

Log:
Document subprocess log events.

Modified:
   supervisor_manual/trunk/chapters/configuration.xml
   supervisor_manual/trunk/chapters/events.xml

Modified: supervisor_manual/trunk/chapters/configuration.xml
==============================================================================
--- supervisor_manual/trunk/chapters/configuration.xml	(original)
+++ supervisor_manual/trunk/chapters/configuration.xml	Fri May 22 18:19:37 2009
@@ -944,6 +944,20 @@
             <entry>3.0</entry>
           </row>
           <row>
+            <entry>stdout_events_enabled</entry>
+            <entry>
+              If true, PROCESS_LOG_STDOUT events will be emitted when
+              the process writes to its stdout file descriptor.  The 
+              events will only be emitted if the file descriptor is 
+              not in capture mode at the time the data is received 
+              (see "Capture Mode and Process Communication Events" 
+              elsewhere in this document). 
+            </entry>
+            <entry>false</entry>
+            <entry>No</entry>
+            <entry>3.0a7</entry>
+          </row>
+          <row>
             <entry>stderr_logfile</entry>
             <entry>
               Put process stderr output in this file unless
@@ -992,6 +1006,20 @@
             <entry>3.0</entry>
           </row>
           <row>
+            <entry>stderr_events_enabled</entry>
+            <entry>
+              If true, PROCESS_LOG_STDERR events will be emitted when
+              the process writes to its stderr file descriptor.  The 
+              events will only be emitted if the file descriptor is 
+              not in capture mode at the time the data is received 
+              (see "Capture Mode and Process Communication Events" 
+              elsewhere in this document).
+            </entry>
+            <entry>false</entry>
+            <entry>No</entry>
+            <entry>3.0a7</entry>
+          </row>
+          <row>
             <entry>environment</entry>
             <entry>
               A list of key/value pairs in the form

Modified: supervisor_manual/trunk/chapters/events.xml
==============================================================================
--- supervisor_manual/trunk/chapters/events.xml	(original)
+++ supervisor_manual/trunk/chapters/events.xml	Fri May 22 18:19:37 2009
@@ -1037,6 +1037,123 @@
 
     <table>
       <title>
+        <code>PROCESS_LOG</code> Event Type
+      </title>
+      <tgroup cols="2">
+        <tbody>
+          <row>
+            <entry>Name</entry>
+            <entry>
+              <code>PROCESS_LOG</code>
+            </entry>
+          </row>
+          <row>
+            <entry>Description</entry>
+            <entry>
+              PROCESS_LOG -- an event type emitted when a process
+              writes to stdout or stderr.  The event will only be
+              emitted if the file descriptor is not in capture mode and
+              if <code>stdout_events_enabled</code> or
+              <code>stderr_events_enabled</code> config options
+              are set to <code>true</code>.  This event type is 
+              abstract, it will never be sent directly.  Subscribing
+              to this event type will cause a subscriber to receive 
+              event notifications for all subtypes of 
+              <code>PROCESS_LOG</code>.
+            </entry>
+          </row>
+          <row>
+            <entry>Body</entry>
+            <entry>N/A</entry>
+          </row>
+          <row>
+            <entry>Subtype Of</entry>
+            <entry><code>EVENT</code></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <table>
+      <title>
+        <code>PROCESS_LOG_STDOUT</code> Event Type
+      </title>
+      <tgroup cols="2">
+        <tbody>
+          <row>
+            <entry>Name</entry>
+            <entry>
+              <code>PROCESS_LOG_STDOUT</code>
+            </entry>
+          </row>
+          <row>
+            <entry>Description</entry>
+            <entry>
+              Indicates a process has written to its stdout file 
+              descriptor.  The event will only be
+              emitted if the file descriptor is not in capture mode 
+              and if the <code>stdout_events_enabled</code> config 
+              option is set to <code>true</code>.  
+            </entry>
+          </row>
+          <row>
+            <entry>Body</entry>
+            <entry>
+              <programlisting>
+processname:name groupname:name pid:pid
+data
+              </programlisting>
+            </entry>
+          </row>
+          <row>
+            <entry>Subtype Of</entry>
+            <entry><code>PROCESS_LOG</code></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table> 
+
+    <table>
+      <title>
+        <code>PROCESS_LOG_STDERR</code> Event Type
+      </title>
+      <tgroup cols="2">
+        <tbody>
+          <row>
+            <entry>Name</entry>
+            <entry>
+              <code>PROCESS_LOG_STDERR</code>
+            </entry>
+          </row>
+          <row>
+            <entry>Description</entry>
+            <entry>
+              Indicates a process has written to its stderr file 
+              descriptor.  The event will only be
+              emitted if the file descriptor is not in capture mode 
+              and if the <code>stderr_events_enabled</code> config 
+              option is set to <code>true</code>.  
+            </entry>
+          </row>
+          <row>
+            <entry>Body</entry>
+            <entry>
+              <programlisting>
+processname:name groupname:name pid:pid
+data
+              </programlisting>
+            </entry>
+          </row>
+          <row>
+            <entry>Subtype Of</entry>
+            <entry><code>PROCESS_LOG</code></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table> 
+
+    <table>
+      <title>
         <code>PROCESS_COMMUNICATION</code> Event Type
       </title>
       <tgroup cols="2">