granicus.if.org Git - apache/blob - docs/manual/mod/mod_logio.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_logio - 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_logio</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_logio.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_logio.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ja/mod/mod_logio.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  32 <a href="../ko/mod/mod_logio.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  33 <a href="../tr/mod/mod_logio.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  34 </div>
  35 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Logging of input and output bytes per request</td></tr>
  36 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  37 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>logio_module</td></tr>
  38 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_logio.c</td></tr></table>
  39 <h3>Summary</h3>
  40
  41
  42     <p>This module provides the logging of input and output number of
  43     bytes received/sent per request. The numbers reflect the actual bytes
  44     as received on the network, which then takes into account the
  45     headers and bodies of requests and responses. The counting is done
  46     before SSL/TLS on input and after SSL/TLS on output, so the numbers
  47     will correctly reflect any changes made by encryption.</p>
  48
  49     <p>This module requires <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code>.</p>
  50
  51     <div class="note">When KeepAlive connections are used with SSL, the overhead of the SSL
  52     handshake is reflected in the byte count of the first request on the
  53     connection.  When per-directory SSL renegotiation occurs, the bytes are associated
  54     with the request that triggered the renegotiation.</div>
  55
  56 </div>
  57 <div id="quickview"><h3>Topics</h3>
  58 <ul id="topics">
  59 <li><img alt="" src="../images/down.gif" /> <a href="#formats">Custom Log Formats</a></li>
  60 </ul><h3 class="directives">Directives</h3>
  61 <ul id="toc">
  62 <li><img alt="" src="../images/down.gif" /> <a href="#logiotrackttfb">LogIOTrackTTFB</a></li>
  63 </ul>
  64 <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_logio">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_logio">Report a bug</a></li></ul><h3>See also</h3>
  65 <ul class="seealso">
  66 <li><code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code></li>
  67 <li><a href="../logs.html">Apache Log Files</a></li>
  68 <li><a href="#comments_section">Comments</a></li></ul></div>
  69 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  70 <div class="section">
  71 <h2><a name="formats" id="formats">Custom Log Formats</a></h2>
  72
  73
  74     <p>This module adds three new logging directives. The characteristics of the
  75     request itself are logged by placing "<code>%</code>" directives in
  76     the format string, which are replaced in the log file by the values as
  77     follows:</p>
  78
  79     <table class="bordered"><tr class="header"><th>Format&nbsp;String</th>
  80         <th>Description</th></tr>
  81 <tr><td><code>%I</code></td>
  82         <td>Bytes received, including request and headers, cannot be
  83         zero.</td></tr>
  84 <tr class="odd"><td><code>%O</code></td>
  85         <td>Bytes sent, including headers, cannot be zero.</td></tr>
  86 <tr><td><code>%S</code></td>
  87         <td>Bytes transferred (received and sent), including request and headers,
  88         cannot be zero. This is the combination of %I and %O.<br />
  89         Available in Apache 2.4.7 and later</td></tr>
  90 <tr class="odd"><td><code>%^FB</code></td>
  91         <td>Delay in microseconds between when the request arrived and the
  92         first byte of the response headers are written.  Only available if
  93         <code class="directive">LogIOTrackTTFB</code> is set to ON.<br />
  94         Available in Apache 2.4.13 and later</td></tr>
  95 </table>
  96
  97     <p>Usually, the functionality is used like this:</p>
  98
  99     <dl>
 100       <dt>Combined I/O log format:</dt>
 101       <dd><code>"%h %l %u %t \"%r\" %&gt;s %b \"%{Referer}i\"
 102       \"%{User-agent}i\" %I %O"</code></dd>
 103     </dl>
 104 </div>
 105 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 106 <div class="directive-section"><h2><a name="LogIOTrackTTFB" id="LogIOTrackTTFB">LogIOTrackTTFB</a> <a name="logiotrackttfb" id="logiotrackttfb">Directive</a></h2>
 107 <table class="directive">
 108 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable tracking of time to first byte (TTFB)</td></tr>
 109 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogIOTrackTTFB ON|OFF</code></td></tr>
 110 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LogIOTrackTTFB OFF</code></td></tr>
 111 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 112 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
 113 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 114 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_logio</td></tr>
 115 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache HTTP Server 2.4.13 and later</td></tr>
 116 </table>
 117     <p>This directive configures whether this module tracks the delay
 118     between the request being read and the first byte of the response
 119     headers being written.  The resulting value may be logged with the
 120     <code>%^FB</code> format.</p>
 121
 122 </div>
 123 </div>
 124 <div class="bottomlang">
 125 <p><span>Available Languages: </span><a href="../en/mod/mod_logio.html" title="English">&nbsp;en&nbsp;</a> |
 126 <a href="../fr/mod/mod_logio.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 127 <a href="../ja/mod/mod_logio.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 128 <a href="../ko/mod/mod_logio.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 129 <a href="../tr/mod/mod_logio.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 130 </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>
 131 <script type="text/javascript"><!--//--><![CDATA[//><!--
 132 var comments_shortname = 'httpd';
 133 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_logio.html';
 134 (function(w, d) {
 135     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 136         d.write('<div id="comments_thread"><\/div>');
 137         var s = d.createElement('script');
 138         s.type = 'text/javascript';
 139         s.async = true;
 140         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 141         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 142     }
 143     else {
 144         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 145     }
 146 })(window, document);
 147 //--><!]]></script></div><div id="footer">
 148 <p class="apache">Copyright 2017 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>
 149 <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[//><!--
 150 if (typeof(prettyPrint) !== 'undefined') {
 151     prettyPrint();
 152 }
 153 //--><!]]></script>
 154 </body></html>