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
8 <title>mod_log_debug - 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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
12 <script src="../style/scripts/prettify.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
17 <div id="page-header">
18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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>
19 <p class="apache">Apache HTTP Server Version 2.5</p>
20 <img alt="" src="../images/feather.gif" /></div>
21 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
23 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_log_debug</h1>
27 <p><span>Available Languages: </span><a href="../en/mod/mod_log_debug.html" title="English"> en </a></p>
29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Additional configurable debug logging</td></tr>
30 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
31 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>log_debug_module</td></tr>
32 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_log_debug.c</td></tr>
33 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.14 and later</td></tr></table>
35 <div id="quickview"><h3 class="directives">Directives</h3>
37 <li><img alt="" src="../images/down.gif" /> <a href="#logmessage">LogMessage</a></li>
41 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
42 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
43 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
45 <h2><a name="examples" id="examples">Examples</a></h2>
49 Log message after request to /foo/* is processed:
51 <pre class="prettyprint lang-config">
52 <Location /foo/>
53 LogMessage "/foo/ has been requested"
60 Log message if request to /foo/* is processed in a sub-request:
61 <pre class="prettyprint lang-config">
62 <Location /foo/>
63 LogMessage "subrequest to /foo/" hook=type_checker expr=%{IS_SUBREQ}
68 The default log_transaction hook is not executed for sub-requests,
69 therefore we have to use a different hook.
74 Log message if an IPv6 client causes a request timeout:
75 <pre class="prettyprint lang-config">
76 LogMessage "IPv6 timeout from %{REMOTE_ADDR}" "expr=-T %{IPV6} && %{REQUEST_STATUS} = 408"
79 Note the placing of the double quotes for the <code>expr=</code> argument.
83 Log the value of the "X-Foo" request environment variable in each
85 <pre class="prettyprint lang-config">
87 LogMessage "%{reqenv:X-Foo}" hook=all
91 Together with microsecond time stamps in the error log,
92 <code>hook=all</code> also allows to determine the times spent
93 in the different parts of the request processing.
98 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
99 <div class="directive-section"><h2><a name="LogMessage" id="LogMessage">LogMessage</a> <a name="logmessage" id="logmessage">Directive</a></h2>
100 <table class="directive">
101 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Log userdefined message to error log
103 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogMessage <var>message</var>
104 [hook=<var>hook</var>] [expr=<var>expression</var>]
106 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
107 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
108 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
109 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_log_debug</td></tr>
111 <p>This directive causes a user defined message to be logged to the
112 error log. The message can use variables and functions from the
113 <a href="../expr.html">ap_expr syntax</a>. The messages are logged at
116 <p>The hook specifies before which phase of request procesing the message
117 will be logged. The following hooks are supported:</p>
119 <table class="bordered"><tr class="header"><th>Name</th></tr>
120 <tr><td><code>translate_name</code></td></tr>
121 <tr class="odd"><td><code>type_checker</code></td></tr>
122 <tr><td><code>quick_handler</code></td></tr>
123 <tr class="odd"><td><code>map_to_storage</code></td></tr>
124 <tr><td><code>check_access</code></td></tr>
125 <tr class="odd"><td><code>check_access_ex</code></td></tr>
126 <tr><td><code>insert_filter</code></td></tr>
127 <tr class="odd"><td><code>check_authn</code></td></tr>
128 <tr><td><code>check_authz</code></td></tr>
129 <tr class="odd"><td><code>fixups</code></td></tr>
130 <tr><td><code>handler</code></td></tr>
131 <tr class="odd"><td><code>log_transaction</code></td></tr>
134 <p>The default is <code>log_transaction</code>. The special value
135 <code>all</code> is also supported, causing a message to be logged at each
136 phase. Not all hooks are executed for every request.</p>
138 <p>The optional expression allows to restrict the message if a
139 condition is met. The details of the expression syntax are described in
140 the <a href="../expr.html">ap_expr documentation</a>.</p>
145 <div class="bottomlang">
146 <p><span>Available Languages: </span><a href="../en/mod/mod_log_debug.html" title="English"> en </a></p>
147 </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&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>
148 <script type="text/javascript"><!--//--><![CDATA[//><!--
149 var comments_shortname = 'httpd';
150 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_log_debug.html';
152 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
153 d.write('<div id="comments_thread"><\/div>');
154 var s = d.createElement('script');
155 s.type = 'text/javascript';
157 s.src = 'https://c.apaste.info/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
158 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
161 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
163 })(window, document);
164 //--><!]]></script></div><div id="footer">
165 <p class="apache">Copyright 2012 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>
166 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!--
167 if (typeof(prettyPrint) !== 'undefined') {