granicus.if.org Git - apache/blob - docs/manual/mod/mod_logio.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4
   5 <!--
   6  Copyright 2002-2004 The Apache Software Foundation
   7
   8  Licensed under the Apache License, Version 2.0 (the "License");
   9  you may not use this file except in compliance with the License.
  10  You may obtain a copy of the License at
  11
  12      http://www.apache.org/licenses/LICENSE-2.0
  13
  14  Unless required by applicable law or agreed to in writing, software
  15  distributed under the License is distributed on an "AS IS" BASIS,
  16  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  See the License for the specific language governing permissions and
  18  limitations under the License.
  19 -->
  20
  21 <modulesynopsis metafile="mod_logio.xml.meta">
  22
  23 <name>mod_logio</name>
  24 <description>Logging of input and output bytes per request</description>
  25 <status>Extension</status>
  26 <sourcefile>mod_logio.c</sourcefile>
  27 <identifier>logio_module</identifier>
  28
  29 <summary>
  30
  31     <p>This module provides the logging of input and output number of
  32     bytes received/sent per request. The numbers reflect the actual bytes
  33     as received on the network, which then takes into account the
  34     headers and bodies of requests and responses. The counting is done
  35     before SSL/TLS on input and after SSL/TLS on output, so the numbers
  36     will correctly reflect any changes made by encryption.</p>
  37
  38     <p>This module requires <module>mod_log_config</module>.</p>
  39
  40 </summary>
  41
  42 <seealso><module>mod_log_config</module></seealso>
  43 <seealso><a href="../logs.html">Apache Log Files</a></seealso>
  44
  45 <section id="formats">
  46 <title>Custom Log Formats</title>
  47
  48     <p>This modules adds two new logging directives. The characteristics of the
  49     request itself are logged by placing "<code>%</code>" directives in
  50     the format string, which are replaced in the log file by the values as
  51     follows:</p>
  52
  53     <table border="1" style="zebra">
  54     <tr><th>Format&nbsp;String</th>
  55         <th>Description</th></tr>
  56
  57     <tr><td><code>%...I</code></td>
  58         <td>Bytes received, including request and headers, cannot be
  59         zero.</td></tr>
  60
  61     <tr><td><code>%...O</code></td>
  62         <td>Bytes sent, including headers, cannot be zero.</td></tr>
  63     </table>
  64
  65     <p>Usually, the functionality is used like this:</p>
  66
  67     <dl>
  68       <dt>Combined I/O log format:</dt>
  69       <dd><code>"%h %l %u %t \"%r\" %&gt;s %b \"%{Referer}i\"
  70       \"%{User-agent}i\" %I %O"</code></dd>
  71     </dl>
  72 </section>
  73
  74 </modulesynopsis>