rubbos/app/httpd-2.0.64/docs/manual/mod/mod_log_forensic.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_log_forensic - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.0</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.0</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_log_forensic</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_log_forensic.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../tr/mod/mod_log_forensic.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  26 </div>
  27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Forensic Logging of the requests made to the server</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>log_forensic_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_log_forensic.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.50 and later</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>This module provides for forensic logging of client
  35     requests. Logging is done before and after processing a request, so the
  36     forensic log contains two log lines for each request.
  37     The forensic logger is very strict, which means:</p>
  38
  39     <ul>
  40     <li>The format is fixed. You cannot modify the logging format at
  41     runtime.</li>
  42     <li>If it cannot write its data, the child process
  43     exits immediately and may dump core (depending on your
  44     <code class="directive"><a href="../mod/mpm_common.html#coredumpdirectory">CoreDumpDirectory</a></code>
  45     configuration).</li>
  46     </ul>
  47
  48     <p>The <code>check_forensic</code> script, which can be found in the
  49     distribution's support directory, may be helpful in evaluating the
  50     forensic log output.</p>
  51
  52     <div class="warning">
  53       This module was backported from version 2.1 which uses a more powerful
  54       APR version in order to generate the forensic IDs. If you want to run
  55       <code class="module"><a href="../mod/mod_log_forensic.html">mod_log_forensic</a></code> in version 2.0, you need to include
  56       <code class="module"><a href="../mod/mod_unique_id.html">mod_unique_id</a></code> as well.
  57     </div>
  58 </div>
  59 <div id="quickview"><h3 class="directives">Directives</h3>
  60 <ul id="toc">
  61 <li><img alt="" src="../images/down.gif" /> <a href="#forensiclog">ForensicLog</a></li>
  62 </ul>
  63 <h3>Topics</h3>
  64 <ul id="topics">
  65 <li><img alt="" src="../images/down.gif" /> <a href="#formats">Forensic Log Format</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Considerations</a></li>
  67 </ul><h3>See also</h3>
  68 <ul class="seealso">
  69 <li><a href="../logs.html">Apache Log Files</a></li>
  70 <li><code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code></li>
  71 </ul></div>
  72 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  73 <div class="section">
  74 <h2><a name="formats" id="formats">Forensic Log Format</a></h2>
  75     <p>Each request is logged two times. The first time is <em>before</em> it's
  76     processed further (that is, after receiving the headers). The second log
  77     entry is written <em>after</em> the request processing at the same time
  78     where normal logging occurs.</p>
  79
  80     <p>In order to identify each request, a unique request ID is assigned.
  81     This forensic ID can be cross logged in the normal transfer log using the
  82     <code>%{forensic-id}n</code> format string. If you're using
  83     <code class="module"><a href="../mod/mod_unique_id.html">mod_unique_id</a></code>, its generated ID will be used.</p>
  84
  85     <p>The first line logs the forensic ID, the request line and all received
  86     headers, separated by pipe characters (<code>|</code>). A sample line
  87     looks like the following (all on one line):</p>
  88
  89     <div class="example"><p><code>
  90         +yQtJf8CoAB4AAFNXBIEAAAAA|GET /manual/de/images/down.gif
  91         HTTP/1.1|Host:localhost%3a8080|User-Agent:Mozilla/5.0 (X11;
  92         U; Linux i686; en-US; rv%3a1.6) Gecko/20040216
  93         Firefox/0.8|Accept:image/png, <var>etc...</var>
  94     </code></p></div>
  95
  96     <p>The plus character at the beginning indicates that this is the first log
  97     line of this request. The second line just contains a minus character and
  98     the ID again:</p>
  99
 100     <div class="example"><p><code>
 101       -yQtJf8CoAB4AAFNXBIEAAAAA
 102     </code></p></div>
 103
 104     <p>The <code>check_forensic</code> script takes as its argument the name
 105     of the logfile. It looks for those <code>+</code>/<code>-</code> ID pairs
 106     and complains if a request was not completed.</p>
 107 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 108 <div class="section">
 109 <h2><a name="security" id="security">Security Considerations</a></h2>
 110     <p>See the <a href="../misc/security_tips.html#serverroot">security tips</a>
 111     document for details on why your security could be compromised
 112     if the directory where logfiles are stored is writable by
 113     anyone other than the user that starts the server.</p>
 114 </div>
 115 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 116 <div class="directive-section"><h2><a name="ForensicLog" id="ForensicLog">ForensicLog</a> <a name="forensiclog" id="forensiclog">Directive</a></h2>
 117 <table class="directive">
 118 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets filename of the forensic log</td></tr>
 119 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ForensicLog <var>filename</var>|<var>pipe</var></code></td></tr>
 120 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 121 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 122 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_log_forensic</td></tr>
 123 </table>
 124     <p>The <code class="directive">ForensicLog</code> directive is used to
 125     log requests to the server for forensic analysis. Each log entry
 126     is assigned a unique ID which can be associated with the request
 127     using the normal <code class="directive"><a href="../mod/mod_log_config.html#customlog">CustomLog</a></code>
 128     directive. <code class="module"><a href="../mod/mod_log_forensic.html">mod_log_forensic</a></code> takes the unique ID from
 129     <code class="module"><a href="../mod/mod_unique_id.html">mod_unique_id</a></code>, so you need to load this module as well.
 130     (This requirement will not be necessary in version 2.1 and later, because
 131     of a more powerful APR version.) The ID token is attached to the request
 132     under the name <code>forensic-id</code>, which can be added to the
 133     transfer log using the <code>%{forensic-id}n</code> format string.</p>
 134
 135     <p>The argument, which specifies the location to which
 136     the logs will be written, can take one of the following two
 137     types of values:</p>
 138
 139     <dl>
 140       <dt><var>filename</var></dt>
 141       <dd>A filename, relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</dd>
 142
 143       <dt><var>pipe</var></dt>
 144       <dd>The pipe character "<code>|</code>", followed by the path
 145       to a program to receive the log information on its standard
 146       input. The program name can be specified relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code> directive.
 147
 148       <div class="warning"><h3>Security:</h3>
 149       <p>If a program is used, then it will be run as the user who
 150       started <code class="program"><a href="../programs/httpd.html">httpd</a></code>. This will be root if the server was
 151       started by root; be sure that the program is secure or switches to a
 152       less privileged user.</p>
 153       </div>
 154
 155       <div class="note"><h3>Note</h3>
 156         <p>When entering a file path on non-Unix platforms, care should be taken
 157         to make sure that only forward slashed are used even though the platform
 158         may allow the use of back slashes. In general it is a good idea to always
 159         use forward slashes throughout the configuration files.</p>
 160       </div></dd>
 161     </dl>
 162
 163 </div>
 164 </div>
 165 <div class="bottomlang">
 166 <p><span>Available Languages: </span><a href="../en/mod/mod_log_forensic.html" title="English">&nbsp;en&nbsp;</a> |
 167 <a href="../tr/mod/mod_log_forensic.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 168 </div><div id="footer">
 169 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 170 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 171 </body></html>