httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scte...@apache.org
Subject svn commit: r1229241 - in /httpd/httpd/branches/2.4.x: ./ docs/STATUS docs/manual/mod/mod_heartbeat.xml docs/manual/mod/mod_heartmonitor.xml docs/manual/mod/mod_watchdog.xml docs/manual/mod/mod_watchdog.xml.meta
Date Mon, 09 Jan 2012 16:34:24 GMT
Author: sctemme
Date: Mon Jan  9 16:34:24 2012
New Revision: 1229241

URL: http://svn.apache.org/viewvc?rev=1229241&view=rev
Log:
Backport documentation updates for mod_heartbeat, mod_heartmonitor and mod_watchdog

Added:
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_watchdog.xml
      - copied unchanged from r1228700, httpd/httpd/trunk/docs/manual/mod/mod_watchdog.xml
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_watchdog.xml.meta
      - copied unchanged from r1228700, httpd/httpd/trunk/docs/manual/mod/mod_watchdog.xml.meta
Modified:
    httpd/httpd/branches/2.4.x/   (props changed)
    httpd/httpd/branches/2.4.x/docs/STATUS
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartbeat.xml
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartmonitor.xml

Propchange: httpd/httpd/branches/2.4.x/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Jan  9 16:34:24 2012
@@ -1,3 +1,3 @@
 /httpd/httpd/branches/revert-ap-ldap:1150158-1150173
 /httpd/httpd/branches/wombat-integration:723609-723841
-/httpd/httpd/trunk:1201042,1201111,1201194,1201198,1201202,1202236,1202456,1202886,1203859,1204630,1204968,1204990,1205061,1205075,1205379,1205885,1206291,1206587,1206850,1207719,1208753,1208835,1209053,1209085,1209417,1209432,1209461,1209601,1209603,1209618,1209623,1209741,1209754,1209766,1209776,1209797-1209798,1209811-1209812,1209814,1209908,1209910,1209913,1209916-1209917,1209947,1209952,1210080,1210124,1210130,1210219,1210221,1210252,1210284,1210378,1210725,1210892,1210951,1210954,1211528,1211663,1211680,1212883,1213338,1213567,1214003,1214005,1214015,1220462,1220467,1220493,1220524,1220570,1220768,1220794,1220826,1220846,1221292,1222335,1222370,1222473,1222915,1222917,1222921,1223048,1225060,1225197-1225198,1225380,1225476,1225478,1225791,1225795-1225796,1226339,1226375,1228816,1229059,1229116,1229134,1229136
+/httpd/httpd/trunk:1201042,1201111,1201194,1201198,1201202,1202236,1202456,1202886,1203859,1204630,1204968,1204990,1205061,1205075,1205379,1205885,1206291,1206587,1206850,1207719,1208753,1208835,1209053,1209085,1209417,1209432,1209461,1209601,1209603,1209618,1209623,1209741,1209754,1209766,1209776,1209797-1209798,1209811-1209812,1209814,1209908,1209910,1209913,1209916-1209917,1209947,1209952,1210080,1210124,1210130,1210219,1210221,1210252,1210284,1210378,1210725,1210892,1210951,1210954,1211528,1211663,1211680,1212883,1213338,1213567,1214003,1214005,1214015,1220462,1220467,1220493,1220524,1220570,1220768,1220794,1220826,1220846,1221292,1222335,1222370,1222473,1222915,1222917,1222921,1223048,1225060,1225197-1225198,1225380,1225476,1225478,1225791,1225795-1225796,1226339,1226375,1228700,1228816,1229024,1229059,1229116,1229134,1229136

Modified: httpd/httpd/branches/2.4.x/docs/STATUS
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/STATUS?rev=1229241&r1=1229240&r2=1229241&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/STATUS (original)
+++ httpd/httpd/branches/2.4.x/docs/STATUS Mon Jan  9 16:34:24 2012
@@ -56,11 +56,7 @@ To Do List
   Start is in expr.xml, igalic is working on this
 
 - modules docs
-    - the follwing modules added since 2.2 lack documentation
-        - mod_watchdog
-        - mod_heartbeat
-        - mod_heartmonitor
-        - mod_lbmethod_heartbeat
+    - the following modules added since 2.2 lack documentation
       the list may be incomplete
       maybe some of the modules will not be included in 2.4
     - mod_suexec: very little documentation

Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartbeat.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartbeat.xml?rev=1229241&r1=1229240&r2=1229241&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartbeat.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartbeat.xml Mon Jan  9 16:34:24 2012
@@ -35,21 +35,56 @@ that advertises the servers current conn
 will be running on a proxy server with <module>mod_lbmethod_heartbeat</module>
loaded, which allows
 <directive module="mod_proxy">ProxyPass</directive> to use the "heartbeat" <em>lbmethod</em>
inside
 of <directive module="mod_proxy">ProxyPass</directive>.</p>
+<p>
+    <module>mod_heartbeat</module> itself is loaded on the origin server(s) that
serve requests 
+    through the proxy server(s).  
+</p>
+
+    <note type="warning">
+        To use <module>mod_heartbeat</module>,
+        <module>mod_status</module> and <module>mod_watchdog</module>
+        must be either a static modules or, if a dynamic module, must
+        be loaded before <module>mod_heartbeat</module>.
+    </note>
+
 </summary>
 
+<section id="consuming">
+    <title>Consuming mod_heartbeat Output</title>
+  <p>
+      Every 1 second, this module generates a single multicast UDP
+      packet, containing the number of busy and idle workers.  The
+      packet is a simple ASCII format, similiar to GET query parameters
+      in HTTP.
+  </p>
+  
+<example><title>An Example Packet</title>
+v=1&amp;ready=75&amp;busy=0
+</example>
+
+  <p>
+    Consumers should handle new variables besides busy and ready,
+    separated by '&amp;', being added in the future.
+  </p>
+
+</section>
+
 <directivesynopsis>
 <name>HeartbeatAddress</name>
-<description>Address to send heartbeat requests</description>
+<description>Multicast address for heartbeat packets</description>
 <syntax>HeartbeatAddress <var>addr:port</var></syntax>
 <default>disabled</default>
 <contextlist><context>server config</context></contextlist>
 
 <usage>
-    <p>The <directive>HeartbeatAddress</directive> directive specifies
the 
-    address <module>mod_heartbeat</module> will send status information to. This
-    address will usually corrspond to a configured  <directive
-    module="mod_heartmonitor">HeartbeatListen</directive> on a frontend
-    proxy system.  </p>
+<p>The <directive>HeartbeatAddress</directive> directive specifies the
+multicast address to which <module>mod_heartbeat</module> will send
+status information. This address will usually correspond to a configured
+ <directive module="mod_heartmonitor">HeartbeatListen</directive> on a
+frontend proxy system.</p>
+<example>
+HeartbeatAddress 239.0.0.1:27999
+</example>    
 </usage>
 </directivesynopsis>
 

Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartmonitor.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartmonitor.xml?rev=1229241&r1=1229240&r2=1229241&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartmonitor.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_heartmonitor.xml Mon Jan  9 16:34:24 2012
@@ -20,19 +20,19 @@
  limitations under the License.
 -->
 
-<modulesynopsis metafile="mod_heartbeat.xml.meta">
+<modulesynopsis metafile="mod_heartmonitor.xml.meta">
 
 <name>mod_heartmonitor</name>
 <description>centralized monitor for mod_heartbeat origin servers</description>
 <status>Experimental</status>
-<sourcefile>mod_heartmonitor</sourcefile>
+<sourcefile>mod_heartmonitor.c</sourcefile>
 <identifier>heartmonitor_module</identifier>
 <compatibility>Available in Apache 2.3 and later</compatibility>
 
 <summary>
 <p>
 <module>mod_heartmonitor</module> listens for server status messages generated

-by <module>mod_heartbeat</module> enabled servers and makes their status 
+by <module>mod_heartbeat</module> enabled origin servers and makes their status

 available to <module>mod_lbmethod_heartbeat</module>. This allows 
 <directive module="mod_proxy">ProxyPass</directive> to use the "heartbeat" 
 <em>lbmethod</em> inside of <directive module="mod_proxy">ProxyPass</directive>.
@@ -41,22 +41,34 @@ available to <module>mod_lbmethod_heartb
 <p>This module uses the services of <module>mod_slotmem_shm</module> when
 available instead of flat-file storage.  No configuration is required to
 use <module>mod_slotmem_shm</module>.</p>
+
+    <note type="warning">
+        To use <module>mod_heartmonitor</module>,
+        <module>mod_status</module> and <module>mod_watchdog</module>
+        must be either a static modules or, if a dynamic module, it must
+        be loaded before <module>mod_heartmonitor</module>.
+    </note>
+
 </summary>
 
 <directivesynopsis>
 <name>HeartbeatListen</name>
-<description>address to listen for incoming heartbeat requests </description>
+<description>multicast address to listen for incoming heartbeat requests </description>
 <syntax>HeartbeatListen<var>addr:port</var></syntax>
 <default>disabled</default>
 <contextlist><context>server config</context></contextlist>
 
 <usage>
     <p>The <directive>HeartbeatListen</directive> directive specifies the
-    address the server will listen on for status information from 
+    multicast address on which the server will listen for status information from 
     <module>mod_heartbeat</module>-enabled servers.  This
-    address will usually corrspond to a configured  <directive
+    address will usually correspond to a configured  <directive
     module="mod_heartbeat">HeartbeatAddress</directive> on an origin server.
     </p>
+    
+    <example>
+    HeartbeatListen 239.0.0.1:27999
+    </example>
 
     <p> This module is inactive until this directive is used.</p>
 </usage>
@@ -88,7 +100,7 @@ heartbeat requests to this server</descr
     <p>The <directive>HeartbeatMaxServers</directive> directive specifies
the
     maximum number of servers that will be sending requests to this monitor
     server.  It is used to control the size of the shared memory allocated
-    to store the heartbeat info.</p>
+    to store the heartbeat info when <module>mod_slotmem_shm</module> is in use.</p>
 </usage>
 </directivesynopsis>
 </modulesynopsis>



Mime
View raw message