You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by di...@apache.org on 2010/03/23 20:36:09 UTC
svn commit: r926745 -
/incubator/trafficserver/site/trunk/docs/v2/admin/files.htm
Author: dianes
Date: Tue Mar 23 19:36:09 2010
New Revision: 926745
URL: http://svn.apache.org/viewvc?rev=926745&view=rev
Log:
closed TS-248
Modified:
incubator/trafficserver/site/trunk/docs/v2/admin/files.htm
Modified: incubator/trafficserver/site/trunk/docs/v2/admin/files.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/admin/files.htm?rev=926745&r1=926744&r2=926745&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/admin/files.htm (original)
+++ incubator/trafficserver/site/trunk/docs/v2/admin/files.htm Tue Mar 23 19:36:09 2010
@@ -7,7 +7,7 @@
<h1>Appendix E - Configuration Files</h1>
<p>
-This appendix describes the Traffic Server configuration files that you can edit. </p>
+This appendix describes Traffic Server configuration files that you can edit. </p>
<ul>
<li><a href="#bypass.config">bypass.config</a> </li>
<li><a href="#cache.config">cache.config</a></li>
@@ -292,60 +292,61 @@ This appendix describes the Traffic Serv
</tr>
<tr>
<td><p><i><code> max_connection_failures</code> </i></p></td>
- <td><p>The maximum number of connection failures allowed within the fail window described below before Traffic Server marks the origin server as congested. The default value is 5.</p></td>
+ <td><p>The maximum number of connection failures allowed within the fail window described below before Traffic Server marks the origin server as congested. The default value is <code>5</code>.</p></td>
</tr>
<tr>
<td><p><i><code>fail_window</code></i></p></td>
- <td><p>The time period during which the maximum number of connection failures can occur before Traffic Server marks the origin server as congested. The default value is 120 seconds.</p></td>
+ <td><p>The time period during which the maximum number of connection failures can occur before Traffic Server marks the origin server as congested. The default value is <code>120</code> seconds.</p></td>
</tr>
<tr>
<td><p><i><code>proxy_retry_interval</code></i></p></td>
- <td><p>The number of seconds that Traffic Server waits before contacting a congested origin server again. The default value is 10 seconds</p></td>
+ <td><p>The number of seconds that Traffic Server waits before contacting a congested origin server again. The default value is <code>10</code> seconds</p></td>
</tr>
<tr>
<td><p><i><code>client_wait_interval</code></i></p></td>
- <td><p>The number of seconds that the client is advised to wait before retrying the congested origin server. The default value is 300 seconds.</p></td>
+ <td><p>The number of seconds that the client is advised to wait before retrying the congested origin server. The default value is <code>300</code> seconds.</p></td>
</tr>
<tr>
<td><p><i><code>wait_interval_alpha</code></i></p></td>
- <td><p>The upper limit for a random number that is added to the wait interval. The default value is 30 seconds.</p></td>
+ <td><p>The upper limit for a random number that is added to the wait interval. The default value is <code>30</code> seconds.</p></td>
</tr>
<tr>
<td><p><i><code>live_os_conn_timeout</code></i></p></td>
- <td><p>The connection timeout to the live (uncongested) origin server. The default value is 60 seconds. <br />
+ <td><p>The connection timeout to the live (uncongested) origin server. The default value is <code>60</code> seconds. <br />
If a client stops a request before the timeout occurs, then Traffic Server does not record a connection failure.</p></td>
</tr>
<tr>
<td><p><i><code>live_os_conn_retries</code></i></p></td>
- <td><p>The maximum number of retries allowed to the live (uncongested) origin server. The default value is 2.</p></td>
+ <td><p>The maximum number of retries allowed to the live (uncongested) origin server. The default value is <code>2</code>.</p></td>
</tr>
<tr>
<td><p><i><code>dead_os_conn_timeout</code></i></p></td>
- <td><p>The connection timeout to the congested origin server. The default value is 15 seconds.</p></td>
+ <td><p>The connection timeout to the congested origin server. The default value is <code>15</code> seconds.</p></td>
</tr>
<tr>
<td><p><i><code>dead_os_conn_retries</code></i></p></td>
- <td><p>The maximum number of retries allowed to the congested origin server. The default value is 1.</p></td>
+ <td><p>The maximum number of retries allowed to the congested origin server. The default value is <code>1</code>.</p></td>
</tr>
<tr>
<td><p><i><code>max_connection</code></i></p></td>
- <td><p>The maximum number of connections allowed from Traffic Server to the origin server. The default value is -1.</p></td>
+ <td><p>The maximum number of connections allowed from Traffic Server to the origin server. The default value is <code>-1</code>.</p></td>
</tr>
<tr>
<td><p><i><code>error_page</code></i></p></td>
- <td><p>The error page sent to the client when a server is congested. You must enclose the value in quotes; the default value is <code> "congestion#retryAfter"</code>.<br />The error page is sent only if the <code>Custom Responses</code> option is enabled (refer to <a href="options.htm#125023">HTTP Responses</a>).</p></td>
+ <td><p>The error page sent to the client when a server is congested. You must enclose the value in quotes; the default value is <code> "congestion#retryAfter"</code><br />
+ </p></td>
</tr>
<tr>
<td><p><i><code>congestion_scheme</code></i></p></td>
- <td><p>Specifies if Traffic Server applies the rule on a per-host (<code>"per_host") </code> or per-IP basis <code> ("per_ip")</code>. The default value is <code> "per_ip"</code>; you must enclose the value in quotes.<br />
- For example: if the server <code> www.host1.com</code> has two IP addresses and you use the tag value <code> "per_ip"</code>, then each IP address has its own number of connection failures and is marked as congested independently. If you use the tag value <code> "per_host"</code> and the server <code> www.host1.com</code> is marked as congested, then <i>both</i> IP addresses are marked as congested. </p></td>
+ <td><p>Specifies if Traffic Server applies the rule on a per-host (<code>"per_host") </code> or per-IP basis <code> ("per_ip")</code>. The default value is <code> "per_ip"</code>; you must enclose the value in quotes.</p>
+ <p> For example: if the server <code> www.host1.com</code> has two IP addresses and you use the tag value <code> "per_ip"</code>, then each IP address has its own number of connection failures and is marked as congested independently. If you use the tag value <code> "per_host"</code> and the server <code> www.host1.com</code> is marked as congested, then <i>both</i> IP addresses are marked as congested. </p></td>
</tr>
</table>
<p>
<strong>Examples</strong></p>
<p>The following <code>congestion.config</code> rule configures Traffic Server to stop forwarding requests to the server <code>www.host.com</code> on port 80 (HTTP traffic) if the server is congested, according to the timeouts specified. Traffic Server uses the default tag values because no tag has been specified.
<br /><code>dest_host=www.host.com port=80</code> </p>
- <p>You can use one or more tags in a rule, but each tag must have one value only. If you specify no tags in the rule, then Traffic Server uses default values. </p>
+ <p>You can use one or more tags in a rule, but each tag must have one value only. If you specify no tags in the rule, then Traffic Server uses the default values. </p>
<p>You can override any of the default tag values by adding configuration variables at the end of <code>records.config</code> as follows: <br />
<code>CONFIG proxy.config.http.congestion_control.default.<em>tag</em> INT|STRING <em>value</em></code> <br />
where <code><i><b>tag</b></i></code> is one of the tags described in the table under <a href="#congestion.config">congestion.config</a> and <code><i><b>value</b></i></code> is the value you want to use.</p>
@@ -2863,7 +2864,7 @@ This request matches the second line. Th
</tr>
<tr>
<td><p><code> <em>request_headers</em></code> </p></td>
- <td><p>Optional. A list of headers (separated by semicolons) passed in each <code> GET</code> request. You can define any request header that conforms to the HTTP specification. The default is no request header.</p></td>
+ <td><p>Optional. A list of headers, separated by semicolons, passed in each <code> GET</code> request. You can define any request header that conforms to the HTTP specification; the default is no request header.</p></td>
</tr>
<tr>
<td><p><code> <em>offset_hour</em></code> </p></td>
@@ -2879,10 +2880,10 @@ This request matches the second line. Th
</tr>
</table>
<h3>Examples</h3>
- <p>The following example illustrates an HTTP scheduled update: <br />
+ <p>An example HTTP scheduled update is provided below: <br />
<code>http://www.company.com\User-Agent: noname user agent\13\3600\5\ </code></p>
-<p>The example above specifies the URL and request headers, an offset hour of 13 (1 pm), an interval of one hour, and a recursion depth of 5. This would result in updates at 13:00, 14:00, 15:00, and so on. To schedule for an update to occur only once a day, use an interval value of 24 hours x 60 minutes x 60 seconds = 86400.</p>
-<h2> <a name="url_regex">Specifying URL Regular Expressions (url_regex)</a></h2>
+<p>The example specifies the URL and request headers, an offset hour of 13 (1 pm), an interval of one hour, and a recursion depth of 5. This would result in updates at 13:00, 14:00, 15:00, and so on. To schedule an update that occurs only once a day, use an interval value 86400 (i.e., 24 hours x 60 minutes x 60 seconds = 86400).</p>
+<h2> <a name="url_regex">Specifying URL Regular Expressions (<code>url_regex</code>)</a></h2>
<p>This section describes how to specify a <code>url_regex</code>. Entries of type <code>url_regex</code> within the configuration files use regular expressions to perform a match. </p>
<p>The following table provides examples to show how to create a valid <code>url_regex</code>. </p>
<table border="1">