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_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.min.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 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.4</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 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.4</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_log_debug</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_log_debug.html" title="English"> en </a> | 28<a href="/fr/mod/mod_log_debug.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p> 29</div> 30<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Additional configurable debug logging</td></tr> 31<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr> 32<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>log_debug_module</td></tr> 33<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_log_debug.c</td></tr> 34<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> 36<div id="quickview"><h3 class="directives">Directives</h3> 37<ul id="toc"> 38<li><img alt="" src="/images/down.gif" /> <a href="#logmessage">LogMessage</a></li> 39</ul> 40<h3>Topics</h3> 41<ul id="topics"> 42<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li> 43</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 44<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 45<div class="section"> 46<h2><a name="examples" id="examples">Examples</a></h2> 47 48 <ol> 49 <li> 50 Log message after request to /foo/* is processed: 51 52 <pre class="prettyprint lang-config"><Location /foo/> 53��LogMessage "/foo/ has been requested" 54</Location></pre> 55 56 </li> 57 58 <li> 59 Log message if request to /foo/* is processed in a sub-request: 60 <pre class="prettyprint lang-config"><Location /foo/> 61��LogMessage "subrequest to /foo/" hook=type_checker expr=%{IS_SUBREQ} 62</Location></pre> 63 64 65 The default log_transaction hook is not executed for sub-requests, 66 therefore we have to use a different hook. 67 </li> 68 69 70 <li> 71 Log message if an IPv6 client causes a request timeout: 72 <pre class="prettyprint lang-config">LogMessage "IPv6 timeout from %{REMOTE_ADDR}" "expr=-T %{IPV6} && %{REQUEST_STATUS} = 408"</pre> 73 74 Note the placing of the double quotes for the <code>expr=</code> argument. 75 </li> 76 77 <li> 78 Log the value of the "X-Foo" request environment variable in each 79 stage of the request: 80 <pre class="prettyprint lang-config"><Location /> 81��LogMessage "%{reqenv:X-Foo}" hook=all 82</Location></pre> 83 84 Together with microsecond time stamps in the error log, 85 <code>hook=all</code> also lets you determine the times spent 86 in the different parts of the request processing. 87 </li> 88 89 </ol> 90</div> 91<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 92<div class="directive-section"><h2><a name="LogMessage" id="LogMessage">LogMessage</a> <a name="logmessage" id="logmessage">Directive</a></h2> 93<table class="directive"> 94<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Log user-defined message to error log 95</td></tr> 96<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogMessage <var>message</var> 97[hook=<var>hook</var>] [expr=<var>expression</var>] 98</code></td></tr> 99<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr> 100<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr> 101<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> 102<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_log_debug</td></tr> 103</table> 104 <p>This directive causes a user defined message to be logged to the 105 error log. The message can use variables and functions from the 106 <a href="/expr.html">ap_expr syntax</a>. References to HTTP headers 107 will not cause header names to be added to the Vary header. The 108 messages are logged at loglevel info.</p> 109 110 <p>The hook specifies before which phase of request processing the message 111 will be logged. The following hooks are supported:</p> 112 113 <table class="bordered"><tr class="header"><th>Name</th></tr> 114<tr><td><code>translate_name</code></td></tr> 115<tr class="odd"><td><code>type_checker</code></td></tr> 116<tr><td><code>quick_handler</code></td></tr> 117<tr class="odd"><td><code>map_to_storage</code></td></tr> 118<tr><td><code>check_access</code></td></tr> 119<tr class="odd"><td><code>check_access_ex</code></td></tr> 120<tr><td><code>insert_filter</code></td></tr> 121<tr class="odd"><td><code>check_authn</code></td></tr> 122<tr><td><code>check_authz</code></td></tr> 123<tr class="odd"><td><code>fixups</code></td></tr> 124<tr><td><code>handler</code></td></tr> 125<tr class="odd"><td><code>log_transaction</code></td></tr> 126</table> 127 128 <p>The default is <code>log_transaction</code>. The special value 129 <code>all</code> is also supported, causing a message to be logged at each 130 phase. Not all hooks are executed for every request.</p> 131 132 <p>The optional expression allows to restrict the message if a 133 condition is met. The details of the expression syntax are described in 134 the <a href="/expr.html">ap_expr documentation</a>. References to HTTP 135 headers will not cause the header names to be added to the Vary header.</p> 136 137 138</div> 139</div> 140<div class="bottomlang"> 141<p><span>Available Languages: </span><a href="/en/mod/mod_log_debug.html" title="English"> en </a> | 142<a href="/fr/mod/mod_log_debug.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p> 143</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> 144<script type="text/javascript"><!--//--><![CDATA[//><!-- 145var comments_shortname = 'httpd'; 146var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_log_debug.html'; 147(function(w, d) { 148 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 149 d.write('<div id="comments_thread"><\/div>'); 150 var s = d.createElement('script'); 151 s.type = 'text/javascript'; 152 s.async = true; 153 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 154 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 155 } 156 else { 157 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 158 } 159})(window, document); 160//--><!]]></script></div><div id="footer"> 161<p class="apache">Copyright 2014 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> 162<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[//><!-- 163if (typeof(prettyPrint) !== 'undefined') { 164 prettyPrint(); 165} 166//--><!]]></script> 167</body></html>
