You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ig...@apache.org on 2011/04/06 16:32:16 UTC
svn commit: r1089470 -
/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/event-logging-formats/index.en.mdtext
Author: igalic
Date: Wed Apr 6 14:32:15 2011
New Revision: 1089470
URL: http://svn.apache.org/viewvc?rev=1089470&view=rev
Log:
Reformat Event Logging Formats.
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/event-logging-formats/index.en.mdtext
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/event-logging-formats/index.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/event-logging-formats/index.en.mdtext?rev=1089470&r1=1089469&r2=1089470&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/event-logging-formats/index.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/event-logging-formats/index.en.mdtext Wed Apr 6 14:32:15 2011
@@ -17,997 +17,315 @@ Notice: Licensed to the Apache Softwa
under the License.
-# Appendix D - Event Logging Formats # {#AppendixD-EventLoggingFormats}
-
+# Event Logging Formats # {#EventLoggingFormats}
- This appendix contains the following sections:
* [Custom Logging Fields](#66912) provides descriptions of logging fields.
* [Logging Format Cross-Reference](#63460) provides cross-references between Trafic Server logging fields and Netscape & Squid logging fields (including Netscape Extended and Extended-2 fields).
## Custom Logging Fields ## {#CustomLoggingFields}
-
+ The following list describes Traffic Server custom logging fields.
- The following table describes Traffic Server custom logging fields.
- **
-
- %<field symbol>
-
-** **
-
- Description
-
-**
-
-` {HTTP header field name}cqh`
-
-:
-
- Logs the information in the requested field of the client request HTTP header.
+`{HTTP header field name}cqh`
+: Logs the information in the requested field of the client request HTTP header.
For example, ` %<{Accept-Language}cqh>` logs the `Accept-Language: `field in
client request headers.
-
-
-` {HTTP header field name}pqh`
-
-:
-
- Logs the information in the requested field of the proxy request HTTP header.
+`{HTTP header field name}pqh`
+: Logs the information in the requested field of the proxy request HTTP header.
For example, ` %<{Authorization}pqh>` logs the` Authorization:` field in proxy
request headers.
-
-
-
-` {HTTP header field name}psh`
-:
-
- Logs the information in the requested field of the proxy response HTTP header.
+`{HTTP header field name}psh`
+: Logs the information in the requested field of the proxy response HTTP header.
For example, ` %<{Retry-After}psh>` logs the `Retry-After:` field in proxy
response headers.
-
-
-
-` {HTTP header field name}ssh`
-:
-
- Logs the information in the requested field of the server response HTTP header.
+`{HTTP header field name}ssh`
+: Logs the information in the requested field of the server response HTTP header.
For example, ` %<{Age}ssh>` logs the `Age:` field in server response headers.
-
-
-
-
-` caun`
-
-:
-
- The client authenticated username; result of the RFC931/ident lookup of the
- client username.
-
-
-` cfsc`
+`caun`
+: The client authenticated username; result of the RFC931/ident lookup of the
+ client username.
-:
-
- The client finish status code; specifies whether the client request to Traffic
+`cfsc`
+: The client finish status code; specifies whether the client request to Traffic
Server was successfully completed (`FIN`) or interrupted (`INTR`).
-
-
-` chi`
+`chi`
+: The IP address of the client's host machine.
-:
-
- The IP address of the client's host machine.
-
-
-
-` cqbl`
-
-:
-
- The client request transfer length; the body length in the client request
+`cqbl`
+: The client request transfer length; the body length in the client request
to Traffic Server (in bytes).
-
-
-` cqhl`
-
-:
-
- The client request header length; the header length in the client request
+`cqhl`
+: The client request header length; the header length in the client request
to Traffic Server.
-
-
-
-` cqhm`
-:
-
- The HTTP method in the client request to Traffic Server: `GET`, `POST`, and
+`cqhm`
+: The HTTP method in the client request to Traffic Server: `GET`, `POST`, and
so on (subset of `cqtx`).
-
-
-` cqhv`
+`cqhv`
+: The client request HTTP version.
-:
-
- The client request HTTP version.
-
-
-
-` cqtd`
-
-:
-
- The client request timestamp. Specifies the date of the client request in
+`cqtd`
+: The client request timestamp. Specifies the date of the client request in
the format yyyy-mm-dd, where yyyy is the 4-digit year, mm is the 2-digit month,
and dd is the 2-digit day.
-
-
-
-` cqtn`
-:
-
- The client request timestamp; date and time of the client's request (in the
+`cqtn`
+: The client request timestamp; date and time of the client's request (in the
Netscape timestamp format).
-
-
-` cqtq`
+`cqtq`
+: The client request timestamp, with millisecond resolution.
-:
-
- The client request timestamp, with millisecond resolution.
-
-
-
-` cqts`
-
-:
-
- The client-request timestamp in Squid format; the time of the client request
+`cqts`
+: The client-request timestamp in Squid format; the time of the client request
since January 1, 1970 UTC. Time is expressed in seconds, with millisecond resolution.
-
-
-
-
-` cqtt`
-
-:
-
- The client request timestamp. The time of the client request in the format
+
+`cqtt`
+: The client request timestamp. The time of the client request in the format
hh:mm:ss, where hh is the two-digit hour in 24-hour format, mm is the two-digit
minutes value, and ss is the 2-digit seconds value (for example, 16:01:19).
-
-
-
-
-` cqtx`
-
-:
-
- The full HTTP client request text, minus headers; for example,
-
-
-
-
- ` GET http://www.company.com HTTP/1.0`
-
-
-
-
- In reverse proxy mode, Traffic Server logs the rewritten/mapped URL (according
+
+`cqtx`
+: The full HTTP client request text, minus headers; for example,
+
+ GET http://www.company.com HTTP/1.0
+
+ In reverse proxy mode, Traffic Server logs the rewritten/mapped URL (according
to the rules in the ` remap.config` file), and _ not_ the pristine/unmapped
URL. To configure Traffic Server to log the original, unmapped URL, set the
variable ` _proxy.config.url_remap.pristine_host_hdr _` in the ` records.config`
file to ` 1` .
-
-
-
-` cqu`
-:
-
- The universal resource identifier (URI) of the request from client to Traffic
+`cqu`
+: The universal resource identifier (URI) of the request from client to Traffic
Server (subset of ` cqtx` ).
-
-
-
-
- In reverse proxy mode, Traffic Server logs the rewritten/mapped URL (according
+
+ In reverse proxy mode, Traffic Server logs the rewritten/mapped URL (according
to the rules in the ` remap.config` file), and _ not _ the pristine/unmapped
URL. To configure Traffic Server to log the original, unmapped URL, set the
variable ` _proxy.config.url_remap.pristine_host_hdr _` in the ` records.config`
file to ` 1` .
-
-
-` cquc`
-
-:
-
- The client request canonical URL. This differs from `cqu` in that blanks (and
+`cquc`
+: The client request canonical URL. This differs from `cqu` in that blanks (and
other characters that might not be parsed by log analysis tools) are replaced
by escape sequences. The escape sequence is a percentage sign followed by the
ASCII code number in hex.
-
-
-
-
+
In reverse proxy mode, Traffic Server logs the rewritten/mapped URL (according
- to the rules in the ` remap.config` file), and_ not _ the pristine/unmapped
+ to the rules in the `remap.config` file), and _not_ the pristine/unmapped
URL. To configure Traffic Server to log the original (unmapped) URL, set the
- ` _proxy.config.url_remap.pristine_host_hdr _` variable in the ` records.config`
+ _`proxy.config.url_remap.pristine_host_hdr`_ variable in the `records.config`
file to ` 1` .
-
-
-
-` cqup`
-:
-
- The client request URL path; specifies the argument portion of the URL (everything after the host).
+`cqup`
+: The client request URL path; specifies the argument portion of the URL (everything after the host).
For example, if the URL is ` http://www.company.com/images/x.gif` , then this field displays ` /images/x.gif`
-
-
-` cqus`
+`cqus`
+: The client request URL scheme.
-:
-
- The client request URL scheme.
-
-
-
-` cquuc`
-
-:
-
- The client request unmapped URL canonical. This field records a URL before
+`cquuc`
+: The client request unmapped URL canonical. This field records a URL before
it is remapped (reverse proxy mode).
-
-
-` crc`
-
-:
-
- The cache result code; specifies how the cache responded to the request (`HIT`,
+`crc`
+: The cache result code; specifies how the cache responded to the request (`HIT`,
`MISS`, and so on).
-
-
-` fsiz`
+`fsiz`
+: The size of the file (_n_ bytes) as seen by the origin server.
-:
-
- The size of the file (_n _ bytes) as seen by the origin server.
-
-
-
-` pfsc`
-
-:
-
- The proxy finish status code; specifies whether the Traffic Server request
+`pfsc`
+: The proxy finish status code; specifies whether the Traffic Server request
to the origin server was successfully completed (`FIN`) or interrupted (`INTR`).
-
-
-
-
-` phn`
-
-:
-
- The hostname of the Traffic Server that generated the log entry in collated
+
+`phn`
+: The hostname of the Traffic Server that generated the log entry in collated
log files.
-
-
-` phr`
+`phr`
+: The proxy hierarchy route; the route Traffic Server used to retrieve the object.
-:
-
- The proxy hierarchy route; the route Traffic Server used to retrieve the object.
-
-
-
-
-` pqbl`
-
-:
-
- The proxy request transfer length; the body length in Traffic Server's request
+`pqbl`
+: The proxy request transfer length; the body length in Traffic Server's request
to the origin server.
-
-
-
-` pqhl`
-:
-
- The proxy request header length; the header length in Traffic Server's request
+`pqhl`
+: The proxy request header length; the header length in Traffic Server's request
to the origin server.
-
-
-` pqsi`
-
-:
-
- The proxy request server IP address (0 on cache hits and parent-ip for requests
+`pqsi`
+: The proxy request server IP address (0 on cache hits and parent-ip for requests
to parent proxies).
-
-
-` pqsn`
+`pqsn`
+: The proxy request server name; the name of the server that fulfilled the request.
-:
-
- The proxy request server name; the name of the server that fulfilled the request.
-
-
-
-
-` prcb`
-
-:
-
- The number of proxy response bytes to the client from the cache.
-
-
-
-` prob`
-
-:
-
- The number of proxy response bytes to the client from the origin server.
-
-
-
-` pscl`
-
-:
-
- The length of the Traffic Server response to the client (in bytes).
-
-
-
-` psct`
-
-:
-
- The content type of the document from server response header: (for example,
- ` img` /` gif` ).
-
-
-
-` pshl`
-
-:
-
- The header length in Traffic Server's response to the client.
-
-
-
-` psql`
-
-:
-
- The proxy response transfer length in Squid format (includes header and content
- length).
-
-
+`prcb`
+: The number of proxy response bytes to the client from the cache.
-` pssc`
+`prob`
+: The number of proxy response bytes to the client from the origin server.
-:
-
- The HTTP response status code from Traffic Server to the client.
-
-
-
-` shi`
-
-:
-
- The IP address resolved from the DNS name lookup of the host in the request. For hosts with multiple IP addresses, this field records the IP address resolved from that particular DNS lookup.
- This can be misleading for cached documents. For example: if the first request was a cache miss and came from` **IP1**` for server `**S**` and the second request for server `**S**` resolved to `**IP2**` but came from the cache, then the log entry for the second request will show **`IP2`**.
-
-
-
-` shn`
-
-:
-
- The hostname of the origin server.
-
-
-
-` sscl`
-
-:
-
- The response length (in bytes) from origin server to Traffic Server.
-
-
-
-` sshl `
-
-:
-
- The header length in the origin server response to Traffic Server (in bytes).
-
-
-
-
-` sshv`
-
-:
-
- The server response HTTP version (1.0, 1.1, etc.).
-
-
-
-` sssc`
-
-:
-
- The HTTP response status code from origin server to Traffic Server.
-
-
-
-` ttms`
-
-:
-
- The time Traffic Server spends processing the client request; the number of
- milliseconds between the time the client establishes the connection with Traffic
- Server and the time Traffic Server sends the last byte of the response back
- to the client.
-
-
+`pscl`
+: The length of the Traffic Server response to the client (in bytes).
-` ttmsf`
-
-:
-
- The time Traffic Server spends processing the client request as a fractional number of seconds. Time is specified in millisecond resolution; however, instead of formatting the output as an integer (as with `ttms`), the display is formatted as a floating-point number representing a fractional number of seconds.
- For example: if the time is 1500 milliseconds, then this field displays 1.5 while the `ttms` field displays 1500 and the `tts` field displays 1.
-
-
-
-` tts`
-
-:
-
- The time Traffic Server spends processing the client request; the number of
- seconds between the time at which the client establishes the connection with
- Traffic Server and the time at which Traffic Server sends the last byte of
- the response back to the client.
-
-
-
-## Logging Format Cross-Reference ## {#LoggingFormatCross-Reference}
-
-
-
- The following sections illustrate the correspondence between Traffic Server
-logging fields and standard logging fields for the Squid and Netscape formats.
-
+`psct`
+: The content type of the document from server response header: (for example,
+ `img/gif` ).
-
+`pshl`
+: The header length in Traffic Server's response to the client.
-### Squid Logging Formats ### {#SquidLoggingFormats}
-
-
-
- The following table lists the Squid logging fields and the corresponding logging
-field symbols.
-
- **
-
- Squid
-
-** **
-
- Field Symbols
-
-**
-
-` time`
-
-:
-
- ` cqts`
-
-
-
-` elapsed`
-
-:
-
- ` ttms`
-
-
+`psql`
+: The proxy response transfer length in Squid format (includes header and content
+ length).
-` client`
+`pssc`
+: The HTTP response status code from Traffic Server to the client.
-:
-
- ` chi`
-
-
+`shi`
+: The IP address resolved from the DNS name lookup of the host in the request.
+ For hosts with multiple IP addresses, this field records the IP address resolveds
+ from that particular DNS lookup.
-` action/code `
+ This can be misleading for cached documents. For example: if the first request was
+ a cache miss and came from **`IP1`** for server **`S`** and the second request for
+ server **`S`** resolved to **`IP2`** but came from the cache, then the log entry
+ for the second request will show **`IP2`**.
-:
-
- ` crc/pssc`
-
-
+`shn`
+: The hostname of the origin server.
-` size`
+`sscl`
+: The response length (in bytes) from origin server to Traffic Server.
-:
-
- ` psql`
-
-
+`sshl `
+: The header length in the origin server response to Traffic Server (in bytes).
-` method`
+`sshv`
+: The server response HTTP version (1.0, 1.1, etc.).
-:
-
- ` cqhm`
-
-
+`sssc`
+: The HTTP response status code from origin server to Traffic Server.
-` url`
+`ttms`
+: The time Traffic Server spends processing the client request; the number of
+ milliseconds between the time the client establishes the connection with Traffic
+ Server and the time Traffic Server sends the last byte of the response back
+ to the client.
-:
-
- ` cquc`
-
-
+`ttmsf`
+: The time Traffic Server spends processing the client request as a fractional number of seconds.
+ Time is specified in millisecond resolution; however, instead of formatting the output as an
+ integer (as with `ttms`), the display is formatted as a floating-point number representing a fractional number of seconds.
-` ident`
+ For example: if the time is 1500 milliseconds, then this field displays 1.5 while the `ttms` field displays 1500
+ and the `tts` field displays 1.
-:
-
- ` caun`
-
-
+`tts`
+: The time Traffic Server spends processing the client request; the number of
+ seconds between the time at which the client establishes the connection with
+ Traffic Server and the time at which Traffic Server sends the last byte of
+ the response back to the client.
-` hierarchy/from`
+## Logging Format Cross-Reference ## {#LoggingFormatCross-Reference}
-:
-
- ` phr/pqsn`
-
-
+The following sections illustrate the correspondence between Traffic Server
+logging fields and standard logging fields for the Squid and Netscape formats.
+
-` content`
+### Squid Logging Formats ### {#SquidLoggingFormats}
-:
-
- ` psct`
-
-
+The following is a list of the Squid logging fields and the corresponding logging
+field symbols.
-### Netscape Common Logging Formats ### {#NetscapeCommonLoggingFormats}
+Squid | Field Symbols
+------|--------------
+`time` | `cqts`
+`elapsed` | `ttms`
+`client` | `chi`
+`action/code ` | `crc/pssc`
+`size` | `psql`
+`method` | `cqhm`
+`url` | `cquc`
+`ident` | `caun`
+`hierarchy/from` | `phr/pqsn`
+`content` | `psct`
-
+### Netscape Common Logging Formats ### {#NetscapeCommonLoggingFormats}
- The following table lists the Netscape Common logging fields and the corresponding
+The following is a list of the Netscape Common logging fields and the corresponding
Traffic Server logging field symbols.
- **
-
- Netscape Common
-
-** **
-
- Field Symbols
-
-**
-
-` host`
-
-:
-
- ` chi`
-
-
-
-` usr`
+Netscape Common | Field Symbols
+----------------|--------------
+`host` | `chi`
+`usr` | `caun`
+`[time]` | `[cqtn]`
+`"req"` | `"cqtx"`
+`s1` | `pssc`
+`c1` | `pscl`
-:
-
- ` caun`
-
-
+### Netscape Extended Logging Formats ### {#NetscapeExtendedLoggingFormats}
-` [time]`
-:
-
- ` [cqtn]`
-
-
-
- `"req"`
-
-:
-
- `"cqtx"`
-
-
-
-` s1`
-
-:
-
- ` pssc`
-
-
-
-` c1`
-
-:
-
- ` pscl`
-
-
-
-### Netscape Extended Logging Formats ### {#NetscapeExtendedLoggingFormats}
-
-
-
- The following table lists the Netscape Extended logging fields and the corresponding
+The following table lists the Netscape Extended logging fields and the corresponding
Traffic Server logging field symbols.
- **
-
- Netscape Extended
+Netscape Extended | Field Symbols
+------------------|--------------
+`host` | `chi`
+`usr` | `caun`
+`[time]` | `[cqtn]`
+`"req"` | `"cqtx"`
+`s1` | `pssc`
+`c1` | `pscl`
+`s2` | `sssc`
+`c2` | `sscl`
+`b1` | `cqbl`
+`b2` | `pqbl`
+`h1` | `cqhl`
+`h2` | `pshl`
+`h3` | `pqhl`
+`h4` | `sshl`
+`xt` | `tts`
-** **
+### Netscape Extended-2 Logging Formats ### {#NetscapeExtended2LoggingFormats}
- Field Symbols
-**
-
-` host`
-
-:
-
- ` chi`
-
-
-
-` usr`
-
-:
-
- ` caun`
-
-
-
-` [time]`
-
-:
-
- ` [cqtn]`
-
-
-
- `"req"`
-
-:
-
- `"cqtx"`
-
-
-
-` s1`
-
-:
-
- ` pssc`
-
-
-
-` c1`
-
-:
-
- ` pscl`
-
-
-
-` s2`
-
-:
-
- ` sssc`
-
-
-
-` c2`
-
-:
-
- ` sscl`
-
-
-
-` b1`
-
-:
-
- ` cqbl`
-
-
-
-` b2`
-
-:
-
- ` pqbl`
-
-
-
-` h1`
-
-:
-
- ` cqhl`
-
-
-
-` h2`
-
-:
-
- ` pshl`
-
-
-
-` h3`
-
-:
-
- ` pqhl`
-
-
-
-` h4`
-
-:
-
- ` sshl`
-
-
-
-` xt`
-
-:
-
- ` tts`
-
-
-
-### Netscape Extended-2 Logging Formats ### {#NetscapeExtended-2LoggingFormats}
-
-
-
- The following table lists the Netscape Extended-2 logging fields and the corresponding
+The following is a list of the Netscape Extended-2 logging fields and the corresponding
Traffic Server logging field symbols.
- **
-
- Netscape Extended-2
-
-** **
-
- Field Symbols
-
-**
-
-` host`
-
-:
-
- ` chi`
-
-
-
-` usr`
-
-:
-
- ` caun`
-
-
-
-` [time]`
-
-:
-
- ` [cqtn]`
-
-
-
- `"req"`
-
-:
-
- `"cqtx"`
-
-
-
-` s1`
-
-:
-
- ` pssc`
-
-
-
-` c1`
-
-:
-
- ` pscl`
-
-
-
-` s2`
-
-:
-
- ` sssc`
-
-
-
-` c2`
-
-:
-
- ` sscl`
-
-
-
-` b1`
-
-:
-
- ` cqbl`
-
-
-
-` b2`
-
-:
-
- ` pqbl`
-
-
-
-` h1`
-
-:
-
- ` cqhl`
-
-
-
-` h2`
-
-:
-
- ` pshl`
-
-
-
-` h3`
-
-:
-
- ` pqhl`
-
-
-
-` h4`
-
-:
-
- ` sshl`
-
-
-
-` xt`
-
-:
-
- ` tts`
-
-
-
-` route`
-
-:
-
- ` phr`
-
-
-
-` pfs`
-
-:
-
- ` cfsc`
-
-
-
-` ss`
-
-:
-
- ` pfsc`
-
-
-
-` crc`
-
-:
-
- ` crc`
-
-
-
-
-
-
-
-
-
-
-
-* [Overview](intro.htm)
-* [Getting Started](getstart.htm)
-* [HTTP Proxy Caching ](http.htm)
-* [Explicit Proxy Caching](explicit.htm)
-* [Reverse Proxy and HTTP Redirects](reverse.htm)
-* [Hierarchical Caching](hier.htm)
-* [Configuring the Cache](cache.htm)
-* [Monitoring Traffic](monitor.htm)
-* [Configuring Traffic Server](configure.htm)
-* [Security Options](secure.htm)
-* [Working with Log Files](log.htm)
-* [Traffic Line Commands](cli.htm)
-* [Event Logging Formats](logfmts.htm)
-* [Configuration Files](files.htm)
-* [Traffic Server Error Messages](errors.htm)
-* [FAQ and Troubleshooting Tips](trouble.htm)
-* [Traffic Server 管çåæå](ts_admin_chinese.pdf) (PDF)
-
-
-
-
-
- Copyright © 2011 [The Apache Software Foundation](http://www.apache.org/).
-Licensed under the [Apache License](http://www.apache.org/licenses/), Version
-2.0. Apache Traffic Server, Apache, the Apache Traffic Server logo, and the
-Apache feather logo are trademarks of The Apache Software Foundation.
-
-
+Netscape Extended-2 | Field Symbols
+--------------------|---------------
+`host` | `chi`
+`usr` | `caun`
+`[time]` | `[cqtn]`
+`"req"` | `"cqtx"`
+`s1` | `pssc`
+`c1` | `pscl`
+`s2` | `sssc`
+`c2` | `sscl`
+`b1` | `cqbl`
+`b2` | `pqbl`
+`h1` | `cqhl`
+`h2` | `pshl`
+`h3` | `pqhl`
+`h4` | `sshl`
+`xt` | `tts`
+`route` | `phr`
+`pfs` | `cfsc`
+`ss` | `pfsc`
+`crc` | `crc`