You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bu...@apache.org on 2011/04/13 03:42:02 UTC
svn commit: r788261 - in
/websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files:
log_hosts.config.en.html logs_xml.config.en.html records.config.en.html
storage.config.en.html update.config.en.html
Author: buildbot
Date: Wed Apr 13 01:42:01 2011
New Revision: 788261
Log:
Staging update by buildbot
Modified:
websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/log_hosts.config.en.html
websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/logs_xml.config.en.html
websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/records.config.en.html
websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/storage.config.en.html
websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/update.config.en.html
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/log_hosts.config.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/log_hosts.config.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/log_hosts.config.en.html Wed Apr 13 01:42:01 2011
@@ -52,7 +52,10 @@ changes to a node in a cluster, Traffic
applies the changes to all other nodes in the cluster.</p>
<h2 id="Format">Format</h2>
<p>Each line in the <code>log_hosts.config</code> file has the following format:</p>
-<p><em><code>hostname</code></em></p>
+<div class="codehilite"><pre>hostname
+</pre></div>
+
+
<p>where <em><code>hostname</code></em> is the hostname of the origin server.</p>
<p><strong>Tip:</strong> You can specify keywords in the <code>log_hosts.config</code> file to
record all transactions from origin servers with the specified
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/logs_xml.config.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/logs_xml.config.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/logs_xml.config.en.html Wed Apr 13 01:42:01 2011
@@ -59,22 +59,24 @@ and all comments.</p>
<h2 id="LogFormat">LogFormat</h2>
<p>The following list shows <strong><code>LogFormat</code></strong> specifications.</p>
<dl>
-<dt id="LogsXMLFormatName"><em><code><Name = "valid_format_name"/></code></em></dt>
-<dd>Required. Valid format names include any name except <code>squid</code>,
+<dt id="LogsXMLFormatName"><em><code><Name = "valid_format_name"/></code></em></dt>
+<dd>Required</dd>
+<dd>Valid format names include any name except <code>squid</code>,
<code>common</code>, <code>extended</code>, or <code>extended2</code>, which are pre-defined
formats. There is no default for this tag.</dd>
-<dt id="LogsXMLFormat"><em><code><Format = "valid_format_specification"/></code></em></dt>
+<dt id="LogsXMLFormat"><em><code><Format = "valid_format_specification"/></code></em></dt>
+<dd>Required</dd>
<dd>
-<p>Required. A valid format specification is a printf-style string
+<p>A valid format specification is a printf-style string
describing each log entry when formatted for ASCII output. Use
- <code>%<</code> <code>*field*</code> <code>></code> as a placeholder for valid field names. For
+ <code>%<</code> <em><code>field</code></em> <code>></code> as a placeholder for valid field names. For
more information, refer to
- <a href="logfmts#custom-logging-fields">Custom Logging Fields</a>.</p>
+ <a href="../event-logging-formats#CustomLoggingFields">Custom Logging Fields</a>.</p>
<p>The specified field can be one of the following types:</p>
<p>Simple. For example: <code>%<cqu></code> <br />
A field within a container, such as an HTTP header or a statistic.
Fields of this type have the syntax:</p>
-<div class="codehilite"><pre> <span class="c">%<{ field } containe></span>
+<div class="codehilite"><pre> <span class="c">%<{ field } container></span>
</pre></div>
@@ -83,7 +85,10 @@ formats. There is no default for this ta
<strong>Note:</strong> You cannot create a format specification that contains
both aggregate operators and regular fields.</p>
</dd>
-<dt id="LogsXMLInterval"><em><code><Interval = "aggregate_interval_secs"/></code></em></dt>
+<dt id="LogsXMLInterval"><em><code><Interval = "aggregate_interval_secs"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>Use this tag when the format contains aggregate operators. The
value "<code>aggregate_interval_secs</code>" represents the number of seconds
@@ -101,14 +106,16 @@ formats. There is no default for this ta
<h2 id="LogFilters">LogFilters</h2>
<p>The following list shows the <code>LogFilter</code> specifications.</p>
<dl>
-<dt id="LogsXMLFilterName"><em><code><Name = "valid_filter_name"/></code></em></dt>
-<dd>Required. All filters must be uniquely named.</dd>
-<dt id="LogsXMLFilterCondition"><em><code><Condition = "valid_log_field valid_operator valid_comparison_value"/></code></em></dt>
+<dt id="LogsXMLFilterName"><em><code><Name = "valid_filter_name"/></code></em></dt>
+<dd>Required</dd>
+<dd>All filters must be uniquely named.</dd>
+<dt id="LogsXMLFilterCondition"><em><code><Condition = "valid_log_field valid_operator valid_comparison_value"/></code></em></dt>
+<dd>Required</dd>
<dd>
-<p>Required. This field contains the following elements:</p>
+<p>This field contains the following elements:</p>
<p><strong><code>valid_log_field</code></strong> - the field that will be compared against
the given value. For more information, refer to
-<a href="logfmts#cross-reference">Logging Format Cross-Reference</a>.</p>
+<a href="../event-logging-formats#LoggingFormatCrossReference">Logging Format Cross-Reference</a>.</p>
<p><strong><code>valid_operator_field</code></strong> - any one of the following: <code>MATCH</code>,
<code>CASE_INSENSITIVE_MATCH</code>, <code>CONTAIN</code>, <code>CASE_INSENSITIVE_CONTAIN</code>.</p>
<ul>
@@ -129,7 +136,7 @@ value.</p>
specify a negative condition, then use the <code>Action</code> field to
<code>REJECT</code> the record.</p>
</dd>
-<dt id="LogsXMLFilterAction"><em><code><Action = "valid_action_field"/></code></em></dt>
+<dt id="LogsXMLFilterAction"><em><code><Action = "valid_action_field"/></code></em></dt>
<dd>
<p>Required: <code>ACCEPT</code> or <code>REJECT</code> .</p>
</dd>
@@ -141,25 +148,30 @@ that satisfy the filter condition.</p>
<h2 id="LogObject">LogObject</h2>
<p>The following list shows the <code>LogObject</code> specifications.</p>
<dl>
-<dt id="LogsXMLObjectFormat"><em><code><Format = "valid_format_name"/></code></em></dt>
-<dd>Required. Valid format names include the predefined logging
+<dt id="LogsXMLObjectFormat"><em><code><Format = "valid_format_name"/></code></em></dt>
+<dd>Required</dd>
+<dd>Valid format names include the predefined logging
formats: <code>squid</code>, <code>common</code>, <code>extended</code>, and <code>extended2</code>, as well as
any previously-defined custom log formats. There is no default for
this tag.</dd>
-<dt id="LogsXMLObjectFilename"><em><code><Filename = "file_name"/></code></em></dt>
+<dt id="LogsXMLObjectFilename"><em><code><Filename = "file_name"/></code></em></dt>
+<dd>Required</dd>
<dd>
-<p>Required. The filename to which the given log file is written on
+<p>The filename to which the given log file is written on
the local file system or on a remote collation server. No local log
file will be created if you fail to specify this tag. All filenames
are relative to the default logging directory.</p>
<p>If the name does not contain an extension (for example, <code>squid</code>),
then the extension <code>.log</code> is automatically appended to it for ASCII
logs and <code>.blog</code> for binary logs (refer to
-<a href="files#0_73225">Mode = "valid_logging_mode"</a>).</p>
+<a href="#LogsXMLOjbectMode">Mode = "valid_logging_mode"</a>).</p>
<p>If you do not want an extension to be added, then end the filename with a
single (.) dot (for example: <code>squid.</code> ).</p>
</dd>
-<dt id="LogsXMLOjbectMode"><em><code><Mode = "valid_logging_mode"/></code></em></dt>
+<dt id="LogsXMLOjbectMode"><em><code><Mode = "valid_logging_mode"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>Valid logging modes include <code>ascii</code> , <code>binary</code> , and <code>ascii_pipe</code> .
The default is <code>ascii</code> .</p>
@@ -185,37 +197,55 @@ transaction is processed, so you can see
Traffic Server starts. Pipes on a collation server, however, <em>are</em>
created when Traffic Server starts.</p>
</dd>
-<dt id="LogsXMLObjectFilters"><em><code><Filters = "list_of_valid_filter_names"/></code></em></dt>
+<dt id="LogsXMLObjectFilters"><em><code><Filters = "list_of_valid_filter_names"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>A comma-separated list of names of any previously-defined log
filters. If more than one filter is specified, then all filters
must accept a record for the record to be logged.</p>
</dd>
-<dt id="LogsXMLObjectProtocols"><em><code><Protocols = "list_of_valid_protocols"/></code></em></dt>
+<dt id="LogsXMLObjectProtocols"><em><code><Protocols = "list_of_valid_protocols"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>A comma-separated list of the protocols this object should log.
Valid protocol names for this release are <code>HTTP</code> (FTP is
deprecated).</p>
</dd>
-<dt id="LogsXMLObjectServerHosts"><em><code><ServerHosts = "list_of_valid_servers"/></code></em></dt>
+<dt id="LogsXMLObjectServerHosts"><em><code><ServerHosts = "list_of_valid_servers"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>A comma-separated list of valid hostnames.This tag indicates that
only entries from the named servers will be included in the file.</p>
</dd>
-<dt id="LogsXMLObjectCollationHosts"><em><code><CollationHosts = "list_of_valid_hostnames"/></code></em></dt>
+<dt id="LogsXMLObjectCollationHosts"><em><code><CollationHosts = "list_of_valid_hostnames"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>A comma-separated list of collation servers to which all log
entries (for this object) are forwarded. Collation servers can be
specified by name or IP address. Specify the collation port with a
colon after the name; for example, <code>host:port</code> .</p>
</dd>
-<dt id="LogsXMLObjectHeader"><em><code><Header = "header"/></code></em></dt>
+<dt id="LogsXMLObjectHeader"><em><code><Header = "header"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>The header text you want the log files to contain. The header text
appears at the beginning of the log file, just before the first
record.</p>
</dd>
-<dt id="LogsXMLObjectRollingEnabled"><em><code><RollingEnabled = "truth value"/></code></em></dt>
+<dt id="LogsXMLObjectRollingEnabled"><em><code><RollingEnabled = "truth value"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>Enables or disables log file rolling for the <code>LogObject</code>. This
setting overrides the value for the
@@ -236,7 +266,10 @@ files reach a specific size (at a specif
the specified size).</li>
</ul>
</dd>
-<dt id="LogsXMLObjectRollingIntervalSec"><em><code><RollingIntervalSec = "seconds"/></code></em></dt>
+<dt id="LogsXMLObjectRollingIntervalSec"><em><code><RollingIntervalSec = "seconds"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>The seconds between log file rolling for the <code>LogObject</code>; enables
you to specify different rolling intervals for different
@@ -245,7 +278,10 @@ you to specify different rolling interva
<em><code>proxy.config.log.rolling_interval_sec</code></em> in the
<code>records.config</code> file.</p>
</dd>
-<dt id="LogsXMLObjectRollingOffsetHr"><em><code><RollingOffsetHr = "hour"/></code></em></dt>
+<dt id="LogsXMLObjectRollingOffsetHr"><em><code><RollingOffsetHr = "hour"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>Specifies an hour (from 0 to 23) at which rolling is guaranteed to
align. Rolling might start before then, but a rolled file will be
@@ -255,7 +291,10 @@ This setting overrides the configuration
for <em><code>proxy.config.log.rolling_offset_hr</code></em> in the
<code>records.config</code> file.</p>
</dd>
-<dt id="LogsXMLObjectRollingSizeMb"><em><code><RollingSizeMb = "size_in_MB"/></code></em></dt>
+<dt id="LogsXMLObjectRollingSizeMb"><em><code><RollingSizeMb = "size_in_MB"/></code></em></dt>
+<dd>
+<p>Optional</p>
+</dd>
<dd>
<p>The size at which log files are rolled.</p>
</dd>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/records.config.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/records.config.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/records.config.en.html Wed Apr 13 01:42:01 2011
@@ -2364,11 +2364,11 @@ specifies the correct interface.</p>
</dd>
</dl>
<h3 id="ScheduledUpdatesConfiguration">Scheduled Update Configuration</h3>
-<p><em><code>proxy.config.update.enabled</code></em>
- <code>INT</code>
- <code>0</code>
- Enables (<code>1</code>) or disables (<code>0</code>) the Scheduled Update option.</p>
<dl>
+<dt id="proxy.config.update.enabled"><em><code>proxy.config.update.enabled</code></em></dt>
+<dd><code>INT</code></dd>
+<dd><code>0</code></dd>
+<dd>Enables (<code>1</code>) or disables (<code>0</code>) the Scheduled Update option.</dd>
<dt id="proxy.config.update.force"><em><code>proxy.config.update.force</code></em></dt>
<dd><code>INT</code></dd>
<dd>Default: <code>0</code></dd>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/storage.config.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/storage.config.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/storage.config.en.html Wed Apr 13 01:42:01 2011
@@ -46,7 +46,10 @@ you modify the <code>storage.config</cod
Server.</p>
<h2 id="Format">Format</h2>
<p>The format of the <code>storage.config</code> file is:</p>
-<p id="pathname_size"><em><code>pathname size</code></em></p>
+<div class="codehilite"><pre>pathname size
+</pre></div>
+
+
<p>where <em><code>pathname</code></em> is the name of a partition, directory or
file, and <em><code>size</code></em> is the size of the named partition,
directory or file (in bytes). You must specify a size for
@@ -63,20 +66,20 @@ formatted or raw disk must be at least 1
<h2 id="Examples">Examples</h2>
<p>The following basic example shows 64 MB of cache storage in the
<code>/big_dir</code> directory:</p>
-<div class="codehilite"><pre> <span class="o">/</span><span class="n">big_dir</span> <span class="mi">67108864</span>
+<div class="codehilite"><pre>/big_dir 67108864
</pre></div>
<p>You can use the <code>.</code> symbol for the current directory. Here is an
example for 64 MB of cache storage in the current directory:</p>
-<div class="codehilite"><pre><span class="o">.</span> <span class="mi">67108864</span>
+<div class="codehilite"><pre>. 67108864
</pre></div>
<h3 id="SolarisExample">Solaris Example</h3>
<p>The following example is for the Solaris operating system:</p>
-<div class="codehilite"><pre><span class="sr">/dev/</span><span class="n">rdsk</span><span class="o">/</span><span class="n">c0t0d0s5</span>
-<span class="sr">/dev/</span><span class="n">rdsk</span><span class="o">/</span><span class="n">c0t0d1s5</span>
+<div class="codehilite"><pre>/dev/rdsk/c0t0d0s5
+/dev/rdsk/c0t0d1s5
</pre></div>
@@ -84,7 +87,7 @@ example for 64 MB of cache storage in th
partition is used.</p>
<h3 id="LinuxExample">Linux Example</h3>
<p>The following example will use an entire raw disk in the Linux operating system:</p>
-<div class="codehilite"><pre><span class="sr">/dev/s</span><span class="n">db</span>
+<div class="codehilite"><pre>/dev/sdb
</pre></div>
</div>
</div><!-- main -->
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/update.config.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/update.config.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/update.config.en.html Wed Apr 13 01:42:01 2011
@@ -133,20 +133,14 @@ expressions to perform a match.</p>
<dt><code>$</code></dt>
<dd>Specifies end of line</dd>
<dt><code>[xyz]</code></dt>
-<dd>A <strong>character class</strong>. In this case, the pattern matches either</dd>
-</dl>
-<p><code>x</code>,<code>y</code>, or<code>z</code></p>
-<dl>
+<dd>A <strong>character class</strong>. In this case, the pattern matches either
+<code>x</code>,<code>y</code>, or<code>z</code></dd>
<dt><code>[abj-oZ]</code></dt>
-<dd>A <strong>character class</strong> with a range. This pattern matches <code>a</code>,<code>b</code>,</dd>
-</dl>
-<p>any letter from<code>j</code>thru<code>o</code>, or<code>Z</code></p>
-<dl>
+<dd>A <strong>character class</strong> with a range. This pattern matches <code>a</code>,<code>b</code>,
+any letter from<code>j</code>thru<code>o</code>, or<code>Z</code></dd>
<dt><code>[^A-Z]</code></dt>
-<dd>A <strong>negated character class</strong>. For example, this pattern matches</dd>
-</dl>
-<p>any character except those in the class.</p>
-<dl>
+<dd>A <strong>negated character class</strong>. For example, this pattern matches
+any character except those in the class.</dd>
<dt><code>r*</code></dt>
<dd>Zero or more<code>r</code>, where<code>r</code>is any regular expression.</dd>
<dt><code>r+</code></dt>
@@ -162,11 +156,9 @@ expressions to perform a match.</p>
<dt><code>"[xyz]\"images"</code></dt>
<dd>The literal string<code>[xyz]"images"</code></dd>
<dt><code>\X</code></dt>
-<dd>If<code>X</code>is<code>a, b, f, n, r, t,</code>or<code>v,</code>then the <code>ANSI-C</code>interpretation of</dd>
-</dl>
-<p><code>\x</code>; otherwise, a literal<code>X</code>. This is used to escape operators
- such as<code>*</code></p>
-<dl>
+<dd>If<code>X</code>is<code>a, b, f, n, r, t,</code>or<code>v,</code>then the <code>ANSI-C</code>interpretation of
+<code>\x</code>; otherwise, a literal<code>X</code>. This is used to escape operators
+such as<code>*</code></dd>
<dt><code>\0</code></dt>
<dd>A<code>NULL</code>character</dd>
<dt><code>\123</code></dt>
@@ -174,18 +166,16 @@ expressions to perform a match.</p>
<dt><code>\x2a</code></dt>
<dd>The character with hexadecimal value<code>2a</code></dd>
<dt><code>(r)</code></dt>
-<dd>Matches an<code>r</code>, where<code>r</code>is any regular expression. You can use</dd>
-</dl>
-<p>parentheses to override precedence.</p>
-<dl>
+<dd>Matches an<code>r</code>, where<code>r</code>is any regular expression. You can use
+parentheses to override precedence.</dd>
<dt><code>rs</code></dt>
<dd>The regular expression<code>r</code>, followed by the regular expression<code>s</code></dd>
<dt><code>r|s</code></dt>
<dd>Either an <code>r</code>or an<code>s</code></dd>
<dt><code>#<n>#</code></dt>
-<dd>Inserts an <strong>end node</strong>, which causes regular expression matching to</dd>
+<dd>Inserts an <strong>end node</strong>, which causes regular expression matching to
+stop when reached. The value<code>n</code>is returned.</dd>
</dl>
-<p>stop when reached. The value<code>n</code>is returned.</p>
<p>You can specify<code>dest_domain=mydomain.com</code>to match any host
in<code>mydomain.com</code>. Likewise, you can specify <code>dest_domain=.</code>to match
any request.</p>