Document frontend_net's: message, stat-req
authorAdam Dickmeiss <adam@indexdata.dk>
Fri, 1 Jun 2012 09:21:18 +0000 (11:21 +0200)
committerAdam Dickmeiss <adam@indexdata.dk>
Fri, 1 Jun 2012 09:21:18 +0000 (11:21 +0200)
doc/frontend_net.xml

index 9d8cdca..394b92b 100644 (file)
    of TCP sessions from the same original IP. The special value 0 means
    : no connection limit. This is also the default if this element is omitted.
   </para>
+  <para>
+   Element <literal>message</literal> is an optional element. If
+   given and non-empty logging is performed by the frontend_net filter
+   (to the log file as given ny option -l).
+  </para>
+  <para>
+   Element <literal>stat-req</literal> is an optional element. It
+   specifies a URL path that triggers a report to be generated by
+   the frontend_net filter. By default this report is disabled (same
+   as empty value). The value itself is the path and should be prefixed
+   with a slash. For example <literal>/fn_stat</literal>.
+  </para>
  </refsect1>
  
  <refsect1><title>SCHEMA</title>
    A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="frontend_net">
-     <port>@:9000</port>
      <threads>10</threads>
+     <port>@:9000</port>
+     <message>FN</message>
+     <stat-req>/fn_stat</stat-req>
     </filter>
 ]]>
    </screen>