granicus.if.org Git - apache/blob - docs/manual/mod/mod_log_debug.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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_log_debug - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_log_debug</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_log_debug.html" title="English">&nbsp;en&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Additional configurable debug logging</td></tr>
  32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>log_debug_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_log_debug.c</td></tr>
  35 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.14 and later</td></tr></table>
  36 </div>
  37 <div id="quickview"><h3>Topics</h3>
  38 <ul id="topics">
  39 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  40 </ul><h3 class="directives">Directives</h3>
  41 <ul id="toc">
  42 <li><img alt="" src="../images/down.gif" /> <a href="#logmessage">LogMessage</a></li>
  43 </ul>
  44 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_log_debug">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_log_debug">Report a bug</a></li></ul><h3>See also</h3>
  45 <ul class="seealso">
  46 <li><a href="#comments_section">Comments</a></li></ul></div>
  47 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  48 <div class="section">
  49 <h2><a name="examples" id="examples">Examples</a></h2>
  50
  51     <ol>
  52       <li>
  53         Log message after request to /foo/* is processed:
  54
  55         <pre class="prettyprint lang-config">&lt;Location "/foo/"&gt;
  56   LogMessage "/foo/ has been requested"
  57 &lt;/Location&gt;</pre>
  58
  59       </li>
  60
  61       <li>
  62         Log message if request to /foo/* is processed in a sub-request:
  63         <pre class="prettyprint lang-config">&lt;Location "/foo/"&gt;
  64   LogMessage "subrequest to /foo/" hook=type_checker "expr=-T %{IS_SUBREQ}"
  65 &lt;/Location&gt;</pre>
  66
  67
  68         The default log_transaction hook is not executed for sub-requests,
  69         therefore we have to use a different hook.
  70       </li>
  71
  72
  73       <li>
  74         Log message if an IPv6 client causes a request timeout:
  75         <pre class="prettyprint lang-config">LogMessage "IPv6 timeout from %{REMOTE_ADDR}" "expr=-T %{IPV6} &amp;&amp; %{REQUEST_STATUS} = 408"</pre>
  76
  77         Note the placing of the double quotes for the <code>expr=</code> argument.
  78       </li>
  79
  80       <li>
  81         Log the value of the "X-Foo" request environment variable in each
  82         stage of the request:
  83         <pre class="prettyprint lang-config">&lt;Location "/"&gt;
  84   LogMessage "%{reqenv:X-Foo}" hook=all
  85 &lt;/Location&gt;</pre>
  86
  87         Together with microsecond time stamps in the error log,
  88         <code>hook=all</code> also lets you determine the times spent
  89         in the different parts of the request processing.
  90       </li>
  91
  92     </ol>
  93 </div>
  94 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  95 <div class="directive-section"><h2><a name="LogMessage" id="LogMessage">LogMessage</a> <a name="logmessage" id="logmessage">Directive</a></h2>
  96 <table class="directive">
  97 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Log user-defined message to error log
  98 </td></tr>
  99 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogMessage <var>message</var>
 100 [hook=<var>hook</var>] [expr=<var>expression</var>]
 101 </code></td></tr>
 102 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
 103 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
 104 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 105 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_log_debug</td></tr>
 106 </table>
 107     <p>This directive causes a user defined message to be logged to the
 108     error log. The message can use variables and functions from the
 109     <a href="../expr.html">ap_expr syntax</a>. References to HTTP headers
 110     will not cause header names to be added to the Vary header. The
 111     messages are logged at loglevel info.</p>
 112
 113     <p>The hook specifies before which phase of request processing the message
 114     will be logged. The following hooks are supported:</p>
 115
 116     <table class="bordered"><tr class="header"><th>Name</th></tr>
 117 <tr><td><code>translate_name</code></td></tr>
 118 <tr class="odd"><td><code>type_checker</code></td></tr>
 119 <tr><td><code>quick_handler</code></td></tr>
 120 <tr class="odd"><td><code>map_to_storage</code></td></tr>
 121 <tr><td><code>check_access</code></td></tr>
 122 <tr class="odd"><td><code>check_access_ex</code></td></tr>
 123 <tr><td><code>insert_filter</code></td></tr>
 124 <tr class="odd"><td><code>check_authn</code></td></tr>
 125 <tr><td><code>check_authz</code></td></tr>
 126 <tr class="odd"><td><code>fixups</code></td></tr>
 127 <tr><td><code>handler</code></td></tr>
 128 <tr class="odd"><td><code>log_transaction</code></td></tr>
 129 </table>
 130
 131     <p>The default is <code>log_transaction</code>. The special value
 132     <code>all</code> is also supported, causing a message to be logged at each
 133     phase. Not all hooks are executed for every request.</p>
 134
 135     <p>The optional expression allows to restrict the message if a
 136     condition is met. The details of the expression syntax are described in
 137     the <a href="../expr.html">ap_expr documentation</a>. References to HTTP
 138     headers will not cause the header names to be added to the Vary header.</p>
 139
 140
 141 </div>
 142 </div>
 143 <div class="bottomlang">
 144 <p><span>Available Languages: </span><a href="../en/mod/mod_log_debug.html" title="English">&nbsp;en&nbsp;</a></p>
 145 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 146 <script type="text/javascript"><!--//--><![CDATA[//><!--
 147 var comments_shortname = 'httpd';
 148 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_log_debug.html';
 149 (function(w, d) {
 150     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 151         d.write('<div id="comments_thread"><\/div>');
 152         var s = d.createElement('script');
 153         s.type = 'text/javascript';
 154         s.async = true;
 155         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 156         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 157     }
 158     else {
 159         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 160     }
 161 })(window, document);
 162 //--><!]]></script></div><div id="footer">
 163 <p class="apache">Copyright 2016 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>
 164 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 165 if (typeof(prettyPrint) !== 'undefined') {
 166     prettyPrint();
 167 }
 168 //--><!]]></script>
 169 </body></html>