rubbos/app/httpd-2.0.64/docs/manual/logs.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>Log Files - 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 id="manual-page"><div id="page-header">
  14 <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>
  15 <p class="apache">Apache HTTP Server Version 2.0</p>
  16 <img alt="" src="./images/feather.gif" /></div>
  17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="./images/left.gif" /></a></div>
  18 <div id="path">
  19 <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></div><div id="page-content"><div id="preamble"><h1>Log Files</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="./en/logs.html" title="English">&nbsp;en&nbsp;</a> |
  22 <a href="./es/logs.html" hreflang="es" rel="alternate" title="Español">&nbsp;es&nbsp;</a> |
  23 <a href="./ja/logs.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  24 <a href="./ko/logs.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  25 <a href="./tr/logs.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  26 </div>
  27
  28     <p>In order to effectively manage a web server, it is necessary
  29     to get feedback about the activity and performance of the
  30     server as well as any problems that may be occurring. The Apache
  31     HTTP Server provides very comprehensive and flexible logging
  32     capabilities. This document describes how to configure its
  33     logging capabilities, and how to understand what the logs
  34     contain.</p>
  35   </div>
  36 <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#security">Security Warning</a></li>
  37 <li><img alt="" src="./images/down.gif" /> <a href="#errorlog">Error Log</a></li>
  38 <li><img alt="" src="./images/down.gif" /> <a href="#accesslog">Access Log</a></li>
  39 <li><img alt="" src="./images/down.gif" /> <a href="#rotation">Log Rotation</a></li>
  40 <li><img alt="" src="./images/down.gif" /> <a href="#piped">Piped Logs</a></li>
  41 <li><img alt="" src="./images/down.gif" /> <a href="#virtualhost">Virtual Hosts</a></li>
  42 <li><img alt="" src="./images/down.gif" /> <a href="#other">Other Log Files</a></li>
  43 </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="security" id="security">Security Warning</a></h2>
  47
  48
  49     <p>Anyone who can write to the directory where Apache is
  50     writing a log file can almost certainly gain access to the uid
  51     that the server is started as, which is normally root. Do
  52     <em>NOT</em> give people write access to the directory the logs
  53     are stored in without being aware of the consequences; see the
  54     <a href="misc/security_tips.html">security tips</a> document
  55     for details.</p>
  56
  57     <p>In addition, log files may contain information supplied
  58     directly by the client, without escaping. Therefore, it is
  59     possible for malicious clients to insert control-characters in
  60     the log files, so care must be taken in dealing with raw
  61     logs.</p>
  62   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  63 <div class="section">
  64 <h2><a name="errorlog" id="errorlog">Error Log</a></h2>
  65
  66
  67     <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td /><td><ul><li><code class="directive"><a href="./mod/core.html#errorlog">ErrorLog</a></code></li><li><code class="directive"><a href="./mod/core.html#loglevel">LogLevel</a></code></li></ul></td></tr></table>
  68
  69     <p>The server error log, whose name and location is set by the
  70     <code class="directive"><a href="./mod/core.html#errorlog">ErrorLog</a></code> directive, is the
  71     most important log file. This is the place where Apache httpd
  72     will send diagnostic information and record any errors that it
  73     encounters in processing requests. It is the first place to
  74     look when a problem occurs with starting the server or with the
  75     operation of the server, since it will often contain details of
  76     what went wrong and how to fix it.</p>
  77
  78     <p>The error log is usually written to a file (typically
  79     <code>error_log</code> on Unix systems and
  80     <code>error.log</code> on Windows and OS/2). On Unix systems it
  81     is also possible to have the server send errors to
  82     <code>syslog</code> or <a href="#piped">pipe them to a
  83     program</a>.</p>
  84
  85     <p>The format of the error log is relatively free-form and
  86     descriptive. But there is certain information that is contained
  87     in most error log entries. For example, here is a typical
  88     message.</p>
  89
  90     <div class="example"><p><code>
  91       [Wed Oct 11 14:32:52 2000] [error] [client 127.0.0.1]
  92       client denied by server configuration:
  93       /export/home/live/ap/htdocs/test
  94     </code></p></div>
  95
  96     <p>The first item in the log entry is the date and time of the
  97     message. The second item lists the severity of the error being
  98     reported. The <code class="directive"><a href="./mod/core.html#loglevel">LogLevel</a></code>
  99     directive is used to control the types of errors that are sent
 100     to the error log by restricting the severity level. The third
 101     item gives the IP address of the client that generated the
 102     error. Beyond that is the message itself, which in this case
 103     indicates that the server has been configured to deny the
 104     client access. The server reports the file-system path (as
 105     opposed to the web path) of the requested document.</p>
 106
 107     <p>A very wide variety of different messages can appear in the
 108     error log. Most look similar to the example above. The error
 109     log will also contain debugging output from CGI scripts. Any
 110     information written to <code>stderr</code> by a CGI script will
 111     be copied directly to the error log.</p>
 112
 113     <p>It is not possible to customize the error log by adding or
 114     removing information. However, error log entries dealing with
 115     particular requests have corresponding entries in the <a href="#accesslog">access log</a>. For example, the above example
 116     entry corresponds to an access log entry with status code 403.
 117     Since it is possible to customize the access log, you can
 118     obtain more information about error conditions using that log
 119     file.</p>
 120
 121     <p>During testing, it is often useful to continuously monitor
 122     the error log for any problems. On Unix systems, you can
 123     accomplish this using:</p>
 124
 125     <div class="example"><p><code>
 126       tail -f error_log
 127     </code></p></div>
 128   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 129 <div class="section">
 130 <h2><a name="accesslog" id="accesslog">Access Log</a></h2>
 131
 132
 133     <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_log_config.html">mod_log_config</a></code></li><li><code class="module"><a href="./mod/mod_setenvif.html">mod_setenvif</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code></li><li><code class="directive"><a href="./mod/mod_log_config.html#logformat">LogFormat</a></code></li><li><code class="directive"><a href="./mod/mod_setenvif.html#setenvif">SetEnvIf</a></code></li></ul></td></tr></table>
 134
 135     <p>The server access log records all requests processed by the
 136     server. The location and content of the access log are
 137     controlled by the <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code>
 138     directive. The <code class="directive"><a href="./mod/mod_log_config.html#logformat">LogFormat</a></code>
 139     directive can be used to simplify the selection of
 140     the contents of the logs. This section describes how to configure the server
 141     to record information in the access log.</p>
 142
 143     <p>Of course, storing the information in the access log is only
 144     the start of log management. The next step is to analyze this
 145     information to produce useful statistics. Log analysis in
 146     general is beyond the scope of this document, and not really
 147     part of the job of the web server itself. For more information
 148     about this topic, and for applications which perform log
 149     analysis, check the <a href="http://dmoz.org/Computers/Software/Internet/Site_Management/Log_analysis/">
 150     Open Directory</a> or <a href="http://dir.yahoo.com/Computers_and_Internet/Software/Internet/World_Wide_Web/Servers/Log_Analysis_Tools/">
 151     Yahoo</a>.</p>
 152
 153     <p>Various versions of Apache httpd have used other modules and
 154     directives to control access logging, including
 155     mod_log_referer, mod_log_agent, and the
 156     <code>TransferLog</code> directive. The <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code> directive now subsumes
 157         the functionality of all the older directives.</p>
 158
 159     <p>The format of the access log is highly configurable. The format
 160     is specified using a format string that looks much like a C-style
 161     printf(1) format string. Some examples are presented in the next
 162     sections. For a complete list of the possible contents of the
 163     format string, see the <code class="module"><a href="./mod/mod_log_config.html">mod_log_config</a></code> <a href="mod/mod_log_config.html#formats">format strings</a>.</p>
 164
 165     <h3><a name="common" id="common">Common Log Format</a></h3>
 166
 167
 168       <p>A typical configuration for the access log might look as
 169       follows.</p>
 170
 171       <div class="example"><p><code>
 172         LogFormat "%h %l %u %t \"%r\" %&gt;s %b" common<br />
 173          CustomLog logs/access_log common
 174       </code></p></div>
 175
 176       <p>This defines the <em>nickname</em> <code>common</code> and
 177       associates it with a particular log format string. The format
 178       string consists of percent directives, each of which tell the
 179       server to log a particular piece of information. Literal
 180       characters may also be placed in the format string and will be
 181       copied directly into the log output. The quote character
 182       (<code>"</code>) must be escaped by placing a backslash before
 183       it to prevent it from being interpreted as the end of the
 184       format string. The format string may also contain the special
 185       control characters "<code>\n</code>" for new-line and
 186       "<code>\t</code>" for tab.</p>
 187
 188       <p>The <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code>
 189           directive sets up a new log file using the defined
 190           <em>nickname</em>. The filename for the access log is relative to
 191           the <code class="directive"><a href="./mod/core.html#serverroot">ServerRoot</a></code> unless it
 192           begins with a slash.</p>
 193
 194       <p>The above configuration will write log entries in a format
 195       known as the Common Log Format (CLF). This standard format can
 196       be produced by many different web servers and read by many log
 197       analysis programs. The log file entries produced in CLF will
 198       look something like this:</p>
 199
 200       <div class="example"><p><code>
 201         127.0.0.1 - frank [10/Oct/2000:13:55:36 -0700] "GET
 202         /apache_pb.gif HTTP/1.0" 200 2326
 203       </code></p></div>
 204
 205       <p>Each part of this log entry is described below.</p>
 206
 207       <dl>
 208         <dt><code>127.0.0.1</code> (<code>%h</code>)</dt>
 209
 210         <dd>This is the IP address of the client (remote host) which
 211         made the request to the server. If <code class="directive"><a href="./mod/core.html#hostnamelookups">HostnameLookups</a></code> is
 212         set to <code>On</code>, then the server will try to determine
 213         the hostname and log it in place of the IP address. However,
 214         this configuration is not recommended since it can
 215         significantly slow the server. Instead, it is best to use a
 216         log post-processor such as <code class="program"><a href="./programs/logresolve.html">logresolve</a></code> to determine
 217         the hostnames. The IP address reported here is not
 218         necessarily the address of the machine at which the user is
 219         sitting. If a proxy server exists between the user and the
 220         server, this address will be the address of the proxy, rather
 221         than the originating machine.</dd>
 222
 223         <dt><code>-</code> (<code>%l</code>)</dt>
 224
 225         <dd>The "hyphen" in the output indicates that the requested
 226         piece of information is not available. In this case, the
 227         information that is not available is the RFC 1413 identity of
 228         the client determined by <code>identd</code> on the clients
 229         machine. This information is highly unreliable and should
 230         almost never be used except on tightly controlled internal
 231         networks. Apache httpd will not even attempt to determine
 232         this information unless <code class="directive"><a href="./mod/core.html#identitycheck">IdentityCheck</a></code> is set
 233         to <code>On</code>.</dd>
 234
 235         <dt><code>frank</code> (<code>%u</code>)</dt>
 236
 237         <dd>This is the userid of the person requesting the document
 238         as determined by HTTP authentication. The same value is
 239         typically provided to CGI scripts in the
 240         <code>REMOTE_USER</code> environment variable. If the status
 241         code for the request (see below) is 401, then this value
 242         should not be trusted because the user is not yet
 243         authenticated. If the document is not password protected,
 244         this part will be "<code>-</code>" just like the previous
 245         one.</dd>
 246
 247         <dt><code>[10/Oct/2000:13:55:36 -0700]</code>
 248         (<code>%t</code>)</dt>
 249
 250         <dd>
 251           The time that the request was received.
 252           The format is:
 253
 254           <p class="indent">
 255             <code>[day/month/year:hour:minute:second zone]<br />
 256              day = 2*digit<br />
 257              month = 3*letter<br />
 258              year = 4*digit<br />
 259              hour = 2*digit<br />
 260              minute = 2*digit<br />
 261              second = 2*digit<br />
 262              zone = (`+' | `-') 4*digit</code>
 263           </p>
 264           It is possible to have the time displayed in another format
 265           by specifying <code>%{format}t</code> in the log format
 266           string, where <code>format</code> is as in
 267           <code>strftime(3)</code> from the C standard library.
 268         </dd>
 269
 270         <dt><code>"GET /apache_pb.gif HTTP/1.0"</code>
 271         (<code>\"%r\"</code>)</dt>
 272
 273         <dd>The request line from the client is given in double
 274         quotes. The request line contains a great deal of useful
 275         information. First, the method used by the client is
 276         <code>GET</code>. Second, the client requested the resource
 277         <code>/apache_pb.gif</code>, and third, the client used the
 278         protocol <code>HTTP/1.0</code>. It is also possible to log
 279         one or more parts of the request line independently. For
 280         example, the format string "<code>%m %U%q %H</code>" will log
 281         the method, path, query-string, and protocol, resulting in
 282         exactly the same output as "<code>%r</code>".</dd>
 283
 284         <dt><code>200</code> (<code>%&gt;s</code>)</dt>
 285
 286         <dd>This is the status code that the server sends back to the
 287         client. This information is very valuable, because it reveals
 288         whether the request resulted in a successful response (codes
 289         beginning in 2), a redirection (codes beginning in 3), an
 290         error caused by the client (codes beginning in 4), or an
 291         error in the server (codes beginning in 5). The full list of
 292         possible status codes can be found in the <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.txt">HTTP
 293         specification</a> (RFC2616 section 10).</dd>
 294
 295         <dt><code>2326</code> (<code>%b</code>)</dt>
 296
 297         <dd>The last part indicates the size of the object returned
 298         to the client, not including the response headers. If no
 299         content was returned to the client, this value will be
 300         "<code>-</code>". To log "<code>0</code>" for no content, use
 301         <code>%B</code> instead.</dd>
 302       </dl>
 303
 304
 305     <h3><a name="combined" id="combined">Combined Log Format</a></h3>
 306
 307
 308       <p>Another commonly used format string is called the Combined
 309       Log Format. It can be used as follows.</p>
 310
 311       <div class="example"><p><code>
 312         LogFormat "%h %l %u %t \"%r\" %&gt;s %b \"%{Referer}i\"
 313         \"%{User-agent}i\"" combined<br />
 314          CustomLog log/access_log combined
 315       </code></p></div>
 316
 317       <p>This format is exactly the same as the Common Log Format,
 318       with the addition of two more fields. Each of the additional
 319       fields uses the percent-directive
 320       <code>%{<em>header</em>}i</code>, where <em>header</em> can be
 321       any HTTP request header. The access log under this format will
 322       look like:</p>
 323
 324       <div class="example"><p><code>
 325         127.0.0.1 - frank [10/Oct/2000:13:55:36 -0700] "GET
 326         /apache_pb.gif HTTP/1.0" 200 2326
 327         "http://www.example.com/start.html" "Mozilla/4.08 [en]
 328         (Win98; I ;Nav)"
 329       </code></p></div>
 330
 331       <p>The additional fields are:</p>
 332
 333       <dl>
 334         <dt><code>"http://www.example.com/start.html"</code>
 335         (<code>\"%{Referer}i\"</code>)</dt>
 336
 337         <dd>The "Referer" (sic) HTTP request header. This gives the
 338         site that the client reports having been referred from. (This
 339         should be the page that links to or includes
 340         <code>/apache_pb.gif</code>).</dd>
 341
 342         <dt><code>"Mozilla/4.08 [en] (Win98; I ;Nav)"</code>
 343         (<code>\"%{User-agent}i\"</code>)</dt>
 344
 345         <dd>The User-Agent HTTP request header. This is the
 346         identifying information that the client browser reports about
 347         itself.</dd>
 348       </dl>
 349
 350
 351     <h3><a name="multiple" id="multiple">Multiple Access Logs</a></h3>
 352
 353
 354       <p>Multiple access logs can be created simply by specifying
 355       multiple <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code>
 356       directives in the configuration
 357       file. For example, the following directives will create three
 358       access logs. The first contains the basic CLF information,
 359       while the second and third contain referer and browser
 360       information. The last two <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code> lines show how
 361       to mimic the effects of the <code>ReferLog</code> and <code>AgentLog</code> directives.</p>
 362
 363       <div class="example"><p><code>
 364         LogFormat "%h %l %u %t \"%r\" %&gt;s %b" common<br />
 365         CustomLog logs/access_log common<br />
 366         CustomLog logs/referer_log "%{Referer}i -&gt; %U"<br />
 367         CustomLog logs/agent_log "%{User-agent}i"
 368       </code></p></div>
 369
 370       <p>This example also shows that it is not necessary to define a
 371       nickname with the <code class="directive"><a href="./mod/mod_log_config.html#logformat">LogFormat</a></code> directive. Instead,
 372       the log format can be specified directly in the <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code> directive.</p>
 373
 374
 375     <h3><a name="conditional" id="conditional">Conditional Logs</a></h3>
 376
 377
 378       <p>There are times when it is convenient to exclude certain
 379       entries from the access logs based on characteristics of the
 380       client request. This is easily accomplished with the help of <a href="env.html">environment variables</a>. First, an
 381       environment variable must be set to indicate that the request
 382       meets certain conditions. This is usually accomplished with
 383       <code class="directive"><a href="./mod/mod_setenvif.html#setenvif">SetEnvIf</a></code>. Then the
 384       <code>env=</code> clause of the <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code> directive is used to
 385           include or exclude requests where the environment variable is
 386           set. Some examples:</p>
 387
 388       <div class="example"><p><code>
 389         # Mark requests from the loop-back interface<br />
 390         SetEnvIf Remote_Addr "127\.0\.0\.1" dontlog<br />
 391         # Mark requests for the robots.txt file<br />
 392         SetEnvIf Request_URI "^/robots\.txt$" dontlog<br />
 393         # Log what remains<br />
 394         CustomLog logs/access_log common env=!dontlog
 395       </code></p></div>
 396
 397       <p>As another example, consider logging requests from
 398       english-speakers to one log file, and non-english speakers to a
 399       different log file.</p>
 400
 401       <div class="example"><p><code>
 402         SetEnvIf Accept-Language "en" english<br />
 403         CustomLog logs/english_log common env=english<br />
 404         CustomLog logs/non_english_log common env=!english
 405       </code></p></div>
 406
 407       <p>Although we have just shown that conditional logging is very
 408       powerful and flexible, it is not the only way to control the
 409       contents of the logs. Log files are more useful when they
 410       contain a complete record of server activity. It is often
 411       easier to simply post-process the log files to remove requests
 412       that you do not want to consider.</p>
 413
 414   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 415 <div class="section">
 416 <h2><a name="rotation" id="rotation">Log Rotation</a></h2>
 417
 418
 419     <p>On even a moderately busy server, the quantity of
 420     information stored in the log files is very large. The access
 421     log file typically grows 1 MB or more per 10,000 requests. It
 422     will consequently be necessary to periodically rotate the log
 423     files by moving or deleting the existing logs. This cannot be
 424     done while the server is running, because Apache will continue
 425     writing to the old log file as long as it holds the file open.
 426     Instead, the server must be <a href="stopping.html">restarted</a> after the log files are
 427     moved or deleted so that it will open new log files.</p>
 428
 429     <p>By using a <em>graceful</em> restart, the server can be
 430     instructed to open new log files without losing any existing or
 431     pending connections from clients. However, in order to
 432     accomplish this, the server must continue to write to the old
 433     log files while it finishes serving old requests. It is
 434     therefore necessary to wait for some time after the restart
 435     before doing any processing on the log files. A typical
 436     scenario that simply rotates the logs and compresses the old
 437     logs to save space is:</p>
 438
 439     <div class="example"><p><code>
 440       mv access_log access_log.old<br />
 441       mv error_log error_log.old<br />
 442       apachectl graceful<br />
 443       sleep 600<br />
 444       gzip access_log.old error_log.old
 445     </code></p></div>
 446
 447     <p>Another way to perform log rotation is using <a href="#piped">piped logs</a> as discussed in the next
 448     section.</p>
 449   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 450 <div class="section">
 451 <h2><a name="piped" id="piped">Piped Logs</a></h2>
 452
 453
 454     <p>Apache httpd is capable of writing error and access log
 455     files through a pipe to another process, rather than directly
 456     to a file. This capability dramatically increases the
 457     flexibility of logging, without adding code to the main server.
 458     In order to write logs to a pipe, simply replace the filename
 459     with the pipe character "<code>|</code>", followed by the name
 460     of the executable which should accept log entries on its
 461     standard input. Apache will start the piped-log process when
 462     the server starts, and will restart it if it crashes while the
 463     server is running. (This last feature is why we can refer to
 464     this technique as "reliable piped logging".)</p>
 465
 466     <p>Piped log processes are spawned by the parent Apache httpd
 467     process, and inherit the userid of that process. This means
 468     that piped log programs usually run as root. It is therefore
 469     very important to keep the programs simple and secure.</p>
 470
 471     <p>One important use of piped logs is to allow log rotation
 472     without having to restart the server. The Apache HTTP Server
 473     includes a simple program called <code class="program"><a href="./programs/rotatelogs.html">rotatelogs</a></code>
 474     for this purpose. For example, to rotate the logs every 24 hours, you
 475     can use:</p>
 476
 477     <div class="example"><p><code>
 478       CustomLog "|/usr/local/apache/bin/rotatelogs
 479       /var/log/access_log 86400" common
 480     </code></p></div>
 481
 482     <p>Notice that quotes are used to enclose the entire command
 483     that will be called for the pipe. Although these examples are
 484     for the access log, the same technique can be used for the
 485     error log.</p>
 486
 487     <p>A similar but much more flexible log rotation program
 488     called <a href="http://www.cronolog.org/">cronolog</a>
 489     is available at an external site.</p>
 490
 491     <p>As with conditional logging, piped logs are a very powerful
 492     tool, but they should not be used where a simpler solution like
 493     off-line post-processing is available.</p>
 494   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 495 <div class="section">
 496 <h2><a name="virtualhost" id="virtualhost">Virtual Hosts</a></h2>
 497
 498
 499     <p>When running a server with many <a href="vhosts/">virtual
 500     hosts</a>, there are several options for dealing with log
 501     files. First, it is possible to use logs exactly as in a
 502     single-host server. Simply by placing the logging directives
 503     outside the <code class="directive"><a href="./mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code> sections in the
 504     main server context, it is possible to log all requests in the
 505     same access log and error log. This technique does not allow
 506     for easy collection of statistics on individual virtual
 507     hosts.</p>
 508
 509     <p>If <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code>
 510     or <code class="directive"><a href="./mod/core.html#errorlog">ErrorLog</a></code>
 511     directives are placed inside a
 512     <code class="directive"><a href="./mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
 513     section, all requests or errors for that virtual host will be
 514     logged only to the specified file. Any virtual host which does
 515     not have logging directives will still have its requests sent
 516     to the main server logs. This technique is very useful for a
 517     small number of virtual hosts, but if the number of hosts is
 518     very large, it can be complicated to manage. In addition, it
 519     can often create problems with <a href="vhosts/fd-limits.html">insufficient file
 520     descriptors</a>.</p>
 521
 522     <p>For the access log, there is a very good compromise. By
 523     adding information on the virtual host to the log format
 524     string, it is possible to log all hosts to the same log, and
 525     later split the log into individual files. For example,
 526     consider the following directives.</p>
 527
 528     <div class="example"><p><code>
 529       LogFormat "%v %l %u %t \"%r\" %&gt;s %b"
 530       comonvhost<br />
 531       CustomLog logs/access_log comonvhost
 532     </code></p></div>
 533
 534     <p>The <code>%v</code> is used to log the name of the virtual
 535     host that is serving the request. Then a program like <a href="programs/other.html">split-logfile</a> can be used to
 536     post-process the access log in order to split it into one file
 537     per virtual host.</p>
 538   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 539 <div class="section">
 540 <h2><a name="other" id="other">Other Log Files</a></h2>
 541
 542
 543     <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_cgi.html">mod_cgi</a></code></li><li><code class="module"><a href="./mod/mod_rewrite.html">mod_rewrite</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mpm_common.html#pidfile">PidFile</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewritelog">RewriteLog</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewriteloglevel">RewriteLogLevel</a></code></li><li><code class="directive"><a href="./mod/mod_cgi.html#scriptlog">ScriptLog</a></code></li><li><code class="directive"><a href="./mod/mod_cgi.html#scriptlogbuffer">ScriptLogBuffer</a></code></li><li><code class="directive"><a href="./mod/mod_cgi.html#scriptloglength">ScriptLogLength</a></code></li></ul></td></tr></table>
 544
 545     <h3><a name="pidfile" id="pidfile">PID File</a></h3>
 546
 547
 548       <p>On startup, Apache httpd saves the process id of the parent
 549       httpd process to the file <code>logs/httpd.pid</code>. This
 550       filename can be changed with the <code class="directive"><a href="./mod/mpm_common.html#pidfile">PidFile</a></code> directive. The
 551       process-id is for use by the administrator in restarting and
 552       terminating the daemon by sending signals to the parent
 553       process; on Windows, use the -k command line option instead.
 554       For more information see the <a href="stopping.html">Stopping
 555       and Restarting</a> page.</p>
 556
 557
 558     <h3><a name="scriptlog" id="scriptlog">Script Log</a></h3>
 559
 560
 561       <p>In order to aid in debugging, the
 562       <code class="directive"><a href="./mod/mod_cgi.html#scriptlog">ScriptLog</a></code> directive
 563       allows you to record the input to and output from CGI scripts.
 564       This should only be used in testing - not for live servers.
 565       More information is available in the <a href="mod/mod_cgi.html">mod_cgi</a> documentation.</p>
 566
 567
 568     <h3><a name="rewritelog" id="rewritelog">Rewrite Log</a></h3>
 569
 570
 571       <p>When using the powerful and complex features of <a href="mod/mod_rewrite.html">mod_rewrite</a>, it is almost
 572       always necessary to use the <code class="directive"><a href="./mod/mod_rewrite.html#rewritelog">RewriteLog</a></code> to help
 573       in debugging. This log file produces a detailed analysis of how
 574       the rewriting engine transforms requests. The level of detail
 575       is controlled by the <code class="directive"><a href="./mod/mod_rewrite.html#rewriteloglevel">RewriteLogLevel</a></code> directive.</p>
 576
 577   </div></div>
 578 <div class="bottomlang">
 579 <p><span>Available Languages: </span><a href="./en/logs.html" title="English">&nbsp;en&nbsp;</a> |
 580 <a href="./es/logs.html" hreflang="es" rel="alternate" title="Español">&nbsp;es&nbsp;</a> |
 581 <a href="./ja/logs.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 582 <a href="./ko/logs.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 583 <a href="./tr/logs.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 584 </div><div id="footer">
 585 <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>
 586 <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>
 587 </body></html>