📄 mod_log_config.html.en
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta name="generator" content="HTML Tidy, see www.w3.org" /> <title>Apache module mod_log_config</title> </head> <!-- Background white, links blue (unvisited), navy (visited), red (active) --> <body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#000080" alink="#FF0000"> <div align="CENTER"> <img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]" /> <h3>Apache HTTP Server Version 1.3</h3> <p><small><em>Is this the version you want? For more recent versions, check our <a href="/docs/">documentation index</a>.</em></small></p> </div> <h1 align="CENTER">Module mod_log_config</h1> <p>This module provides for logging of the requests made to the server, using the Common Log Format or a user-specified format.</p> <p><a href="module-dict.html#Status" rel="Help"><strong>Status:</strong></a> Base<br /> <a href="module-dict.html#SourceFile" rel="Help"><strong>Source File:</strong></a> mod_log_config.c<br /> <a href="module-dict.html#ModuleIdentifier" rel="Help"><strong>Module Identifier:</strong></a> config_log_module<br /> <a href="module-dict.html#Compatibility" rel="Help"><strong>Compatibility:</strong></a> Was an extension module prior to Apache 1.2.</p> <h2>Summary</h2> <p>This module provides for flexible logging of client requests. Logs are written in a customizable format, and may be written directly to a file, or to an external program. Conditional logging is provided so that individual requests may be included or excluded from the logs based on characteristics of the request.</p> <p>Three directives are provided by this module: <code>TransferLog</code> to create a log file, <code>LogFormat</code> to set a custom format, and <code>CustomLog</code> to define a log file and format in one step. The <code>TransferLog</code> and <code>CustomLog</code> directives can be used multiple times in each server to cause each request to be logged to multiple files.</p> <p>See also: <a href="../logs.html">Apache Log Files</a>.</p> <h2>Directives</h2> <ul> <li><a href="#cookielog">CookieLog</a></li> <li><a href="#customlog">CustomLog</a></li> <li><a href="#logformat">LogFormat</a></li> <li><a href="#transferlog">TransferLog</a></li> </ul> <h2><a id="formats" name="formats">Custom Log Formats</a></h2> <p>The format argument to the <code>LogFormat</code> and <code>CustomLog</code> directives is a string. This string is used to log each request to the log file. It can contain literal characters copied into the log files and the C-style control characters "\n" and "\t" to represent new-lines and tabs. Literal quotes and back-slashes should be escaped with back-slashes.</p> <p>The characteristics of the request itself are logged by placing "<code>%</code>" directives in the format string, which are replaced in the log entry by the values as follows:</p><pre>%...a: Remote IP-address%...A: Local IP-address%...B: Bytes sent, excluding HTTP headers.%...b: Bytes sent, excluding HTTP headers. In CLF format i.e. a '-' rather than a 0 when no bytes are sent.%...c: Connection status when response was completed. 'X' = connection aborted before the response completed. '+' = connection may be kept alive after the response is sent. '-' = connection will be closed after the response is sent.%...{FOOBAR}e: The contents of the environment variable FOOBAR%...f: Filename%...h: Remote host%...H The request protocol%...{Foobar}i: The contents of Foobar: header line(s) in the request sent to the server.%...l: Remote logname (from identd, if supplied)%...m The request method%...{Foobar}n: The contents of note "Foobar" from another module.%...{Foobar}o: The contents of Foobar: header line(s) in the reply.%...p: The canonical Port of the server serving the request%...P: The process ID of the child that serviced the request.%...q The query string (prepended with a ? if a query string exists, otherwise an empty string)%...r: First line of request%...s: Status. For requests that got internally redirected, this is the status of the *original* request --- %...>s for the last.%...t: Time, in common log format time format (standard english format)%...{format}t: The time, in the form given by format, which should be in strftime(3) format. (potentially localized)%...T: The time taken to serve the request, in seconds.%...u: Remote user (from auth; may be bogus if return status (%s) is 401)%...U: The URL path requested, not including any query string.%...v: The canonical ServerName of the server serving the request.%...V: The server name according to the UseCanonicalName setting.</pre> <p>The "..." can be nothing at all (<em>e.g.</em>, <code>"%h %u %r %s %b"</code>), or it can indicate conditions for inclusion of the item (which will cause it to be replaced with "-" if the condition is not met). The forms of condition are a list of HTTP status codes, which may or may not be preceded by "!". Thus, "%400,501{User-agent}i" logs User-agent: on 400 errors and 501 errors (Bad Request, Not Implemented) only; "%!200,304,302{Referer}i" logs Referer: on all requests which did <strong>not</strong> return some sort of normal status.</p> <p>Note that in versions previous to 1.3.25 no escaping was performed on the strings from <code>%...r</code>, <code>%...i</code> and <code>%...o</code>. This was mainly to comply with the requirements of the Common Log Format. This implied that clients could insert control characters into the log, so you had to be quite careful when dealing with raw log files.</p> <p>For security reasons starting with 1.3.25 non-printable and other special characters are escaped mostly by using <code>\x<var>hh</var></code> sequences, where <var>hh</var> stands for the hexadecimal representation of the raw byte. Exceptions from this rule are <code>"</code> and <code>\</code> which are escaped by prepending a backslash, and all whitespace characters that are written in their C-style notation (<code>\n</code>, <code>\t</code>, etc).</p> <p>Some commonly used log format strings are:</p> <dl> <dt>Common Log Format (CLF)</dt> <dd><code>"%h %l %u %t \"%r\" %>s %b"</code></dd> <dt>Common Log Format with Virtual Host</dt> <dd><code>"%v %h %l %u %t \"%r\" %>s %b"</code></dd> <dt>NCSA extended/combined log format</dt> <dd><code>"%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""</code></dd> <dt>Referer log format</dt> <dd><code>"%{Referer}i -> %U"</code></dd> <dt>Agent (Browser) log format</dt> <dd><code>"%{User-agent}i"</code></dd> </dl> <p>Note that the canonical <a href="core.html#servername">ServerName</a> and <a href="core.html#port">Port</a> of the server serving the request are used for <code>%v</code> and <code>%p</code> respectively. This happens regardless of the <a href="core.html#usecanonicalname">UseCanonicalName</a> setting because otherwise log analysis programs would have to duplicate the entire vhost matching algorithm in order to decide what host really served the request.</p> <h2>Security Considerations</h2> <p>See the <a href="../misc/security_tips.html#serverroot">security tips</a> document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server.</p> <h2>Compatibility notes</h2> <ul> <li>This module is based on mod_log_config distributed with previous Apache releases, now updated to handle multiple logs. There is now no need to rebuild Apache to change configuration log formats.</li> <li>The module also implements the <code>CookieLog</code> directive, used to log user-tracking information created by <a href="mod_usertrack.html">mod_usertrack</a>. The use of <code>CookieLog</code> is deprecated, and a <code>CustomLog</code> should be defined to log user-tracking information instead.</li> <li>As of Apache 1.3.5, this module allows conditional logging based upon the setting of <a href="../env.html">environment variables</a>. That is, you can control whether a request should be logged or not based upon whether an arbitrary environment variable is defined or⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -