trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mlib...@apache.org
Subject svn commit: r833617 [1/6] - in /incubator/trafficserver/site/trunk/docs/admin: cache.htm cli.htm doc.css files.htm http.htm leftnav.html log.htm secure.htm top.html
Date Sat, 07 Nov 2009 00:35:48 GMT
Author: mlibbey
Date: Sat Nov  7 00:35:48 2009
New Revision: 833617

URL: http://svn.apache.org/viewvc?rev=833617&view=rev
Log:
DianeS doc changes + self-closing tags + changing to unix line changes from dos

Modified:
    incubator/trafficserver/site/trunk/docs/admin/cache.htm
    incubator/trafficserver/site/trunk/docs/admin/cli.htm
    incubator/trafficserver/site/trunk/docs/admin/doc.css
    incubator/trafficserver/site/trunk/docs/admin/files.htm
    incubator/trafficserver/site/trunk/docs/admin/http.htm
    incubator/trafficserver/site/trunk/docs/admin/leftnav.html
    incubator/trafficserver/site/trunk/docs/admin/log.htm
    incubator/trafficserver/site/trunk/docs/admin/secure.htm
    incubator/trafficserver/site/trunk/docs/admin/top.html

Modified: incubator/trafficserver/site/trunk/docs/admin/cache.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/cache.htm?rev=833617&r1=833616&r2=833617&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/cache.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/cache.htm Sat Nov  7 00:35:48 2009
@@ -3,7 +3,8 @@
 <title>Traffic Edge Administrator’s Guide</title>
 <meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
 
-<link rel="stylesheet" href="doc.css" type="text/css" media="all" /></head>
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" />
+</head>
 
 <body>
 <h1>Configuring the Cache</h1>
@@ -58,7 +59,7 @@
 </ol>
 <p>&nbsp;</p>
 <h2 id="ChangingCacheCapacity">Changing Cache Capacity</h2>
-<p>You can increase or reduce the total amount of disk space allocated to the cache without clearing the content. <br> To check the size of the cache (in bytes), enter the command <code>traffic_line -r proxy.process.cache.bytes_total</code>. </p>
+<p>You can increase or reduce the total amount of disk space allocated to the cache without clearing the content. <br /> To check the size of the cache (in bytes), enter the command <code>traffic_line -r proxy.process.cache.bytes_total</code>. </p>
 <h3>Increasing Cache Capacity </h3>
 <p>To increase the total amount of disk space allocated to the cache on existing disks or to add new disks to a Traffic Server node, follow the steps below:</p>
 <ol>
@@ -125,7 +126,7 @@
     </tr>
     <tr>
       <td><code><i>proxy.config.cache.max_doc_size</i></code></td>
-      <td>Set this variable to specify the maximum size allowed for objects in the cache in bytes. Enter 0 (zero) if you do not want to have a size limit.</td>
+      <td>Set this variable to specify the maximum size allowed for objects in the cache in bytes.<br /> Enter <code>0</code> (zero) if you do not want  a size limit.</td>
   </tr>
 </table>
 <br />
@@ -138,7 +139,7 @@
 <h5>To clear the cache: </h5>
 <ol>
   <li>Stop Traffic Server; refer to <a href="getstart.htm#StoppingTrafficEdge"><em>Stopping Traffic Server</em></a>. </li>
-  <li>Enter the following command to clear the cache:<br><code>traffic_server -Cclear</code><br>The <code>clear</code> command deletes all data in the object store and the host database. Traffic Server does not prompt you to confirm the deletion.  </li>
+  <li>Enter the following command to clear the cache:<br /><code>traffic_server -Cclear</code><br />The <code>clear</code> command deletes all data in the object store and the host database. Traffic Server does not prompt you to confirm the deletion.  </li>
   <li>Restart Traffic Server; refer to <a href="getstart.htm#StartingTrafficEdge"><em>Starting Traffic Server</em></a>.</li>
 </ol>
 <h2 id="InspectingCache">Inspecting the Cache</h2>
@@ -147,22 +148,28 @@
 <p>To access the Cache Inspector utility, follow the steps below:</p>
 <ol>
   <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
-  <li>Add the following variable at the end of the file:<br><code><i>CONFIG proxy.config.http_ui_enabled INT 1</i></code></li>
-  <li>From the Traffic Server <code>bin</code> directory, enter the following command to re-read the configuration file:<br>
+  <li>Add the following variable at the end of the file:<br /><code><i>CONFIG proxy.config.http_ui_enabled INT 1</i></code></li>
+  <li>To access the cache inspector in reverse proxy mode, you must add a remap rule to <code>remap.config</code> to expose the URL. <br />
+    For example: <br />
+  <code>map http://yourhost.com/myCI http://{cache} @action=allow @src_ip=corp_internal_address</code></li>
+  <li>From the Traffic Server <code>bin</code> directory, enter the following command to re-read the configuration file:<br />
     <code>traffic_line -x</code></li>
   <li>Open your web browser and configure it to use your Traffic Server as a proxy server. Type the following URL:
-<br><code>http://{cache}</code></li>
-  <li>The Cache page opens; refer to <a href="#UsingCachePage"><em>Using the Cache Page</em></a>. </li>
+<br /><code>http://{cache}</code></li>
+  <li>The Cache page opens; refer to <a href="#UsingCachePage"><em>Using the Cache Page</em></a> below.</li>
 </ol>
 <h3 id="UsingCachePage">Using the Cache Page </h3>
-<p>The Cache page provides several options that let you view and delete the contents of your cache: </p>
+<p>The <b>Cache page</b> provides several options that enable you to view and delete the contents of your cache: </p>
 <ul>
   <li>Click <strong>Lookup url</strong> to search for a particular URL in the cache. When Traffic Server finds the URL in the cache, it displays details about the object that corresponds to the URL (such as the header length and the number of alternates). From the display page, you can delete the URL from the cache. </li>
   <li>Click <strong>Delete url</strong> to delete a particular URL or list of URLs from the cache. Traffic Server indicates if a delete is successful. </li>
-  <li>Click <strong>Regex lookup</strong> to search for URLs that match one or more regular expressions. From the display page, you can delete the URLs listed.<br> For example, enter the following to search for all URLs that end in html and are prefixed with <code>http://www.abc.com: <br>http://www.abc.com/.*\.html$</code></li>
-  <li>Click <strong>Regex delete</strong> to delete all URLs that match a specified regular expression.<br> For example, enter the following to delete all HTTP URLs that end in <code>html</code>: <br><code>http://.*\.html$</code> </li>
+  <li>Click <strong>Regex lookup</strong> to search for URLs that match one or more regular expressions. From the display page, you can delete the URLs listed.<br /> 
+  For example, enter the following to search for all URLs that end in html and are prefixed with <code>http://www.dianes.com: <br />
+  http://www.dianes.com/.*\.html$</code></li>
+  <li>Click <strong>Regex delete</strong> to delete all URLs that match a specified regular expression.<br /> For example, enter the following to delete all HTTP URLs that end in <code>html</code>: <br /><code>http://.*\.html$</code> </li>
   <li>Click <strong>Regex invalidate</strong> to invalidate URLs that match a specified regular expression. When you invalidate a URL, Traffic Server marks the object that corresponds to the URL as stale in the cache. Traffic Server then contacts the origin server to check if the object is still fresh (revalidates) before serving it from the cache. </li>
 </ul>
 <p><strong>Note:</strong> Only one administrator should delete and invalidate cache entries from the Cache page at any point in time. Changes made by multiple administrators at the same time can lead to unpredictable results.</p>
+
 </body>  
 </html>
\ No newline at end of file

Modified: incubator/trafficserver/site/trunk/docs/admin/cli.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/cli.htm?rev=833617&r1=833616&r2=833617&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/cli.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/cli.htm Sat Nov  7 00:35:48 2009
@@ -1,410 +1,412 @@
-<html>
-  <head>
-    <title>Traffic Line Commands</title>
-<meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
-<link rel="stylesheet" href="doc.css" type="text/css" media="all" /></head>
-  <body>
-  <h1><a name="1053643">Appendix C - Traffic Line Commands</a>
-    
-  </h1>
-  <p>    This appendix contains the following sections:  </p>
-
-<ul>
-<li><a href="#1053987"><em>Traffic Line Commands</em></a></li>
-<li><a href="#1025718"><em>Traffic Line Variables</em></a></li>
-</ul>
-<h2>
-        <a name="1053987">Traffic Line Commands</a>     </h2>
-     <p>       Use Traffic Line to execute individual Traffic Server commands and to script multiple commands in a shell.   You execute Traffic Line commands from the Traffic Server <code>bin</code> directory. If the Traffic Server <code>bin</code> directory is not in your path, then prepend the Traffic Line command with <code>./</code> (for example: <code>./traffic_line -p</code>).  </p>
-  <p>       The following table describes all the commands available in Traffic Line.  </p>
-      <table border="1">
-        <tr>
-          <th> <p> Command</p></th>
-          <th> <p> Description</p></th>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -b</code> </p></td>
-          <td><p> Bounces the Traffic Server on the local node. Bouncing the Traffic Server shuts down and immediately restarts the Traffic Server node.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -c</code> </p></td>
-          <td><p> Clears the accumulated statistics on the local node.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -h</code> </p></td>
-          <td><p> Displays the list of Traffic Line commands.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -p <em>socket_path</em></code> </p></td>
-          <td><p> Specifies the location (directory and path) of the socket used for Traffic Line  communication.<br> 
-          The default path is: <br>
-          <code><em>install_dir</em> /config/cli</code> </p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -q</code> </p></td>
-          <td><p> Displays a list of the origin servers that are currently congested. </p>
-              <p> <b>Note:</b> To use this command, you must set the variable <code> <i>proxy.config.raf.enabled</i></code> to 1 and then set the variable <code> <i>proxy.config.raf.port</i></code> to a different port <em CLASS="Emphasis"> only</em> if there is a conflict with the default port 9000.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -r  <em>variable</em></code> </p></td>
-          <td><p> Displays specific performance statistics or a current configuration setting. For a list of the variables you can specify, refer to <a href="cli.htm#1025718"><em>Traffic Line Variables</em></a>.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -s  <em>variable</em> -v  <em>value</em></code> </p></td>
-          <td><p> Sets configuration variables, where <code><i>variable</i></code> is the configuration variable you want to change and <code> <i>value</i></code> is the value you want to set. Refer to <a href="files.htm#115367"><em> records.config</em></a> for a list of the configuration variables you can specify.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -x</code> </p></td>
-          <td><p> Initiates a Traffic Server configuration file reread. Use this command after every configuration file modification.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -B</code> </p></td>
-          <td><p> Bounces all the Traffic Server nodes in the cluster. Bouncing the Traffic Server shuts down and immediately restarts Traffic Server node by node.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -C</code> </p></td>
-          <td><p> Clears the accumulated statistics on all the nodes in the cluster.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -L</code> </p></td>
-          <td><p> Restarts the <code> traffic_manager</code> process and the <code> traffic_server</code> process on the local node.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -M</code> </p></td>
-          <td><p> Restarts the <code> traffic_manager</code> process and the <code> traffic_server</code> process on all the nodes in a cluster.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -S</code> </p></td>
-          <td><p> Shuts down the Traffic Server on the local node.</p></td>
-        </tr>
-        <tr>
-          <td><p> <code> traffic_line -U</code> </p></td>
-          <td><p> Starts the Traffic Server on the local node.</p></td>
-        </tr>
-      </table>
-<p>
-        <strong><a name="1025718">Traffic Line Variables</a></strong>
-  </p>
-  <p>       You can view statistics and change configuration options in Traffic Line by using specific variables. The variables used for gathering statistics are described below. The variables used for viewing and changing configuration options are described in <a href="files.htm#115367"><em>records.config</em></a>. For procedures on how to specify the variables, refer to <a href="monitor.htm"><em>Viewing Statistics from Traffic Line</em></a>, and <a href="configure.htm"><em>Configuring Traffic Server Using Traffic Line</em></a>.  </p>
-  <p>       The variables used for viewing individual statistics are described in the following table.  To view a statistic in Traffic Line, enter the command <code>traffic_line -r <em>variable</em> </code>at the prompt.  </p>
-     <table border="1">
-       <tr>
-         <td><p><strong> Statistic</strong></p></td>
-         <td><p><strong> Variable</strong></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p><strong> Summary</strong></p></td>
-       </tr>
-       <tr>
-         <td><p> Node name</p></td>
-         <td><p> <i><code> proxy.node.hostname </code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Objects served</p></td>
-         <td><p> <i><code> proxy.node.user_agents_total_documents_served</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Transactions per second</p></td>
-         <td><p> <i><code> proxy.node.user_agent_xacts_per_second</code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p><strong> Node</strong></p></td>
-       </tr>
-       <tr>
-         <td><p> Document hit rate </p></td>
-         <td><p> <i><code> proxy.node.cache_hit_ratio_avg_10s</code> </i></p>
-             <p> <i><code> proxy.cluster.cache_hit_ratio_avg_10s</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Bandwidth savings </p></td>
-         <td><p> <i><code> proxy.node.bandwidth_hit_ratio_avg_10s</code> </i></p>
-             <p> <i><code> proxy.cluster.bandwidth_hit_ratio_avg_10s </code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Cache percent free</p></td>
-         <td><p> <i><code> proxy.node.cache.percent_free</code> </i></p>
-             <p> <i><code> proxy.cluster.cache.percent_free</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Open origin server connections</p></td>
-         <td><p> <i><code> proxy.node.current_server_connections</code> </i></p>
-             <p> <i><code> proxy.cluster.current_server_connections </code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Open client connections </p></td>
-         <td><p> <i><code> proxy.node.current_client_connections</code> </i></p>
-             <p> <i><code> proxy.cluster.current_client_connections </code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Cache transfers in progress </p></td>
-         <td><p> <i><code> proxy.node.current_cache_connections</code> </i></p>
-             <p> <i><code> proxy.cluster.current_cache_connections </code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Client throughput (Mbits/sec)</p></td>
-         <td><p> <i><code> proxy.node.client_throughput_out</code> </i></p>
-             <p> <i><code> proxy.cluster.client_throughput_out</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Transactions per second </p></td>
-         <td><p> <i><code> proxy.node.user_agent_xacts_per_second </code> </i></p>
-             <p> <i><code> proxy.cluster.user_agent_xacts_per_second</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> DNS lookups per second </p></td>
-         <td><p> <i><code> proxy.node.dns.lookups_per_second </code> </i></p>
-             <p> <i><code> proxy.cluster.dns.lookups_per_second </code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Host database hit rate </p></td>
-         <td><p> <i><code> proxy.node.hostdb.hit_ratio_avg_10s</code> </i></p>
-             <p> <i><code> proxy.cluster.hostdb.hit_ratio_avg_10s </code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p><strong> HTTP</strong></p></td>
-       </tr>
-       <tr>
-         <td><p> Total document bytes from client</p></td>
-         <td><p> <i><code> proxy.process.http.user_agent_response_document_total_size</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Total header bytes from client</p></td>
-         <td><p> <i><code> proxy.process.http.user_agent_response_header_total_size</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Total connections to client</p></td>
-         <td><p> <i><code> proxy.process.http.total_client_connections</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Client transactions in progress</p></td>
-         <td><p> <i><code> proxy.process.http.current_client_transactions</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Total document bytes from origin server</p></td>
-         <td><p> <i><code> proxy.process.http.origin_server_response_document_total_size</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Total header bytes from origin server</p></td>
-         <td><p> <i><code> proxy.process.http.origin_server_response_header_total_size</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Total connections to origin server</p></td>
-         <td><p> <i><code> proxy.process.http.total_server_connections</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Origin server transactions in progress </p></td>
-         <td><p> <i><code> proxy.process.http.current_server_transactions</code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p><strong> ICP</strong></p></td>
-       </tr>
-       <tr>
-         <td><p> ICP query requests originating from this node</p></td>
-         <td><p> <i><code> proxy.process.icp.icp_query_requests</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> ICP query messages sent from this node</p></td>
-         <td><p> <i><code> proxy.process.icp.total_udp_send_queries</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> ICP peer hit messages received from this node</p></td>
-         <td><p> <i><code> proxy.process.icp.icp_query_hits</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> ICP peer miss messages received from this node </p></td>
-         <td><p> <i><code> proxy.process.icp.icp_query_misses</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Total ICP responses received from this node</p></td>
-         <td><p> <i><code> proxy.process.icp.icp_remote_responses</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Average ICP message response time (ms) from this node</p></td>
-         <td><p> <i><code> proxy.process.icp.total_icp_response_time</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Average ICP request time (ms) from this node</p></td>
-         <td><p> <i><code> proxy.process.icp.total_icp_request_time</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Query messages received from ICP peers</p></td>
-         <td><p> <i><code> proxy.process.icp.icp_remote_query_requests</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Remote query hits from ICP peers</p></td>
-         <td><p> <i><code> proxy.process.icp.cache_lookup_success</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Remote query misses from ICP peers</p></td>
-         <td><p> <i><code> proxy.process.icp.cache_lookup_fail</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Successful response messages sent to peers</p></td>
-         <td><p> <i><code> proxy.process.icp.query_response_write</code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p><strong> Cache </strong></p></td>
-       </tr>
-       <tr>
-         <td><p> Bytes used</p></td>
-         <td><p> <i><code> proxy.process.cache.bytes_used</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Cache size</p></td>
-         <td><p> <i><code> proxy.process.cache.bytes_total</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Lookups in progress</p></td>
-         <td><p> <i><code> proxy.process.cache.lookup.active</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Lookups completed</p></td>
-         <td><p> <i><code> proxy.process.cache.lookup.success</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Lookup misses</p></td>
-         <td><p> <i><code> proxy.process.cache.lookup.failure</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Reads in progress</p></td>
-         <td><p> <i><code> proxy.process.cache.read.active</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Reads completed</p></td>
-         <td><p> <i><code> proxy.process.cache.read.success</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Read misses</p></td>
-         <td><p> <i><code> proxy.process.cache.read.failure</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Writes in progress</p></td>
-         <td><p> <i><code> proxy.process.cache.write.active</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Writes completed</p></td>
-         <td><p> <i><code> proxy.process.cache.write.success</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Write failures</p></td>
-         <td><p> <i><code> proxy.process.cache.write.failure</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Updates in progress</p></td>
-         <td><p> <i><code> proxy.process.cache.update.active</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Updates completed</p></td>
-         <td><p> <i><code> proxy.process.cache.update.success</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Update failures</p></td>
-         <td><p> <i><code> proxy.process.cache.update.failure</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Removes in progress</p></td>
-         <td><p> <i><code> proxy.process.cache.remove.active</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Remove successes</p></td>
-         <td><p> <i><code> proxy.process.cache.remove.success</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Remove failures</p></td>
-         <td><p> <i><code> proxy.process.cache.remove.failure</code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p> <strong> Host Database</strong> </p></td>
-       </tr>
-       <tr>
-         <td><p> Total lookups</p></td>
-         <td><p> <i><code> proxy.process.hostdb.total_lookups</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Total hits</p></td>
-         <td><p> <i><code> proxy.process.hostdb.total_hits</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Time TTL (min)</p></td>
-         <td><p> <i><code> proxy.process.hostdb.ttl</code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p> <strong> DNS</strong> </p></td>
-       </tr>
-       <tr>
-         <td><p> DNS total lookups</p></td>
-         <td><p> <i><code> proxy.process.dns.total_dns_lookups</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Average lookup time (ms)</p></td>
-         <td><p> <i><code> proxy.process.dns.lookup_avg_time</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> DNS successes</p></td>
-         <td><p> <i><code> proxy.process.dns.lookup_successes</code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p><strong> Cluster </strong></p></td>
-       </tr>
-       <tr>
-         <td><p> Bytes read</p></td>
-         <td><p> <i><code> proxy.process.cluster.read_bytes</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Bytes written</p></td>
-         <td><p> <i><code> proxy.process.cluster.write_bytes</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Connections open</p></td>
-         <td><p> <i><code> proxy.process.cluster.connections_open</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Total operations</p></td>
-         <td><p> <i><code> proxy.process.cluster.connections_opened</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Network backups</p></td>
-         <td><p> <i><code> proxy.process.cluster.net_backup</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Clustering nodes</p></td>
-         <td><p> <i><code> proxy.process.cluster.nodes</code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p><strong> Logging </strong></p></td>
-       </tr>
-       <tr>
-         <td><p> Currently open log files</p></td>
-         <td><p> <i><code> proxy.process.log2.log_files_open</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Space used for log files</p></td>
-         <td><p> <i><code> proxy.process.log2.log_files_space_used</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Number of access events logged</p></td>
-         <td><p> <i><code> proxy.process.log2.event_log_access</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Number of access events skipped</p></td>
-         <td><p> <i><code> proxy.process.log2.event_log_access_skip</code> </i></p></td>
-       </tr>
-       <tr>
-         <td><p> Number of error events logged</p></td>
-         <td><p> <i><code> proxy.process.log2.event_log_error</code> </i></p></td>
-       </tr>
-       <tr>
-         <td rowspan="1" colspan="2"><p><strong> Congestion Control</strong></p></td>
-       </tr>
-       <tr>
-         <td><p> Number of congestions Traffic Server has observed because the maximum number of connections were exceeded.</p></td>
-         <td><p> <i><code>proxy.process.congestion.congested_on_max_connection</code></i></p></td>
-       </tr>
-       <tr>
-         <td><p> Number of congestions Traffic Server has observed because of an operating system response or timeout failure.</p></td>
-         <td><p><i><code>proxy.process.congestion.congested_on_conn_failures</code></i></p></td>
-       </tr>
-     </table>
-
-</body>
+<html>
+  <head>
+    <title>Traffic Line Commands</title>
+<meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
+
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" />
+</head>
+  <body>
+  <h1><a name="1053643">Appendix C - Traffic Line Commands</a>
+    
+  </h1>
+  <p>    This appendix contains the following sections:  </p>
+
+<ul>
+<li><a href="#1053987"><em>Traffic Line Commands</em></a></li>
+<li><a href="#1025718"><em>Traffic Line Variables</em></a></li>
+</ul>
+<h2>
+        <a name="1053987">Traffic Line Commands</a>     </h2>
+     <p>       Use Traffic Line to execute individual Traffic Server commands and to script multiple commands in a shell.   You execute Traffic Line commands from the Traffic Server <code>bin</code> directory. If the Traffic Server <code>bin</code> directory is not in your path, then prepend the Traffic Line command with <code>./</code> (for example: <code>./traffic_line -p</code>).  </p>
+  <p>       The following table describes all the commands available in Traffic Line.  </p>
+      <table border="1">
+        <tr>
+          <th> <p> Command</p></th>
+          <th> <p> Description</p></th>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -b</code> </p></td>
+          <td><p> Bounces the Traffic Server on the local node. Bouncing the Traffic Server shuts down and immediately restarts the Traffic Server node.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -c</code> </p></td>
+          <td><p> Clears the accumulated statistics on the local node.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -h</code> </p></td>
+          <td><p> Displays the list of Traffic Line commands.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -p <em>socket_path</em></code> </p></td>
+          <td><p> Specifies the location (directory and path) of the socket used for Traffic Line  communication.<br /> 
+          The default path is: <br />
+          <code><em>install_dir</em> /config/cli</code> </p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -q</code> </p></td>
+          <td><p> Displays a list of the origin servers that are currently congested. </p>
+              <p> <b>Note:</b> To use this command, you must set the variable <code> <i>proxy.config.raf.enabled</i></code> to 1 and then set the variable <code> <i>proxy.config.raf.port</i></code> to a different port <em CLASS="Emphasis"> only</em> if there is a conflict with the default port 9000.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -r  <em>variable</em></code> </p></td>
+          <td><p> Displays specific performance statistics or a current configuration setting. For a list of the variables you can specify, refer to <a href="cli.htm#1025718"><em>Traffic Line Variables</em></a>.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -s  <em>variable</em> -v  <em>value</em></code> </p></td>
+          <td><p> Sets configuration variables, where <code><i>variable</i></code> is the configuration variable you want to change and <code> <i>value</i></code> is the value you want to set. Refer to <a href="files.htm#115367"><em> records.config</em></a> for a list of the configuration variables you can specify.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -x</code> </p></td>
+          <td><p> Initiates a Traffic Server configuration file reread. Use this command after every configuration file modification.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -B</code> </p></td>
+          <td><p> Bounces all the Traffic Server nodes in the cluster. Bouncing the Traffic Server shuts down and immediately restarts Traffic Server node by node.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -C</code> </p></td>
+          <td><p> Clears the accumulated statistics on all the nodes in the cluster.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -L</code> </p></td>
+          <td><p> Restarts the <code> traffic_manager</code> process and the <code> traffic_server</code> process on the local node.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -M</code> </p></td>
+          <td><p> Restarts the <code> traffic_manager</code> process and the <code> traffic_server</code> process on all the nodes in a cluster.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -S</code> </p></td>
+          <td><p> Shuts down the Traffic Server on the local node.</p></td>
+        </tr>
+        <tr>
+          <td><p> <code> traffic_line -U</code> </p></td>
+          <td><p> Starts the Traffic Server on the local node.</p></td>
+        </tr>
+      </table>
+<p>
+        <strong><a name="1025718">Traffic Line Variables</a></strong>
+  </p>
+  <p>       You can view statistics and change configuration options in Traffic Line by using specific variables. The variables used for gathering statistics are described below. The variables used for viewing and changing configuration options are described in <a href="files.htm#115367"><em>records.config</em></a>. For procedures on how to specify the variables, refer to <a href="monitor.htm"><em>Viewing Statistics from Traffic Line</em></a>, and <a href="configure.htm"><em>Configuring Traffic Server Using Traffic Line</em></a>.  </p>
+  <p>       The variables used for viewing individual statistics are described in the following table.  To view a statistic in Traffic Line, enter the command <code>traffic_line -r <em>variable</em> </code>at the prompt.  </p>
+     <table border="1">
+       <tr>
+         <td><p><strong> Statistic</strong></p></td>
+         <td><p><strong> Variable</strong></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p><strong> Summary</strong></p></td>
+       </tr>
+       <tr>
+         <td><p> Node name</p></td>
+         <td><p> <i><code> proxy.node.hostname </code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Objects served</p></td>
+         <td><p> <i><code> proxy.node.user_agents_total_documents_served</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Transactions per second</p></td>
+         <td><p> <i><code> proxy.node.user_agent_xacts_per_second</code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p><strong> Node</strong></p></td>
+       </tr>
+       <tr>
+         <td><p> Document hit rate </p></td>
+         <td><p> <i><code> proxy.node.cache_hit_ratio_avg_10s</code> </i></p>
+             <p> <i><code> proxy.cluster.cache_hit_ratio_avg_10s</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Bandwidth savings </p></td>
+         <td><p> <i><code> proxy.node.bandwidth_hit_ratio_avg_10s</code> </i></p>
+             <p> <i><code> proxy.cluster.bandwidth_hit_ratio_avg_10s </code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Cache percent free</p></td>
+         <td><p> <i><code> proxy.node.cache.percent_free</code> </i></p>
+             <p> <i><code> proxy.cluster.cache.percent_free</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Open origin server connections</p></td>
+         <td><p> <i><code> proxy.node.current_server_connections</code> </i></p>
+             <p> <i><code> proxy.cluster.current_server_connections </code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Open client connections </p></td>
+         <td><p> <i><code> proxy.node.current_client_connections</code> </i></p>
+             <p> <i><code> proxy.cluster.current_client_connections </code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Cache transfers in progress </p></td>
+         <td><p> <i><code> proxy.node.current_cache_connections</code> </i></p>
+             <p> <i><code> proxy.cluster.current_cache_connections </code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Client throughput (Mbits/sec)</p></td>
+         <td><p> <i><code> proxy.node.client_throughput_out</code> </i></p>
+             <p> <i><code> proxy.cluster.client_throughput_out</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Transactions per second </p></td>
+         <td><p> <i><code> proxy.node.user_agent_xacts_per_second </code> </i></p>
+             <p> <i><code> proxy.cluster.user_agent_xacts_per_second</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> DNS lookups per second </p></td>
+         <td><p> <i><code> proxy.node.dns.lookups_per_second </code> </i></p>
+             <p> <i><code> proxy.cluster.dns.lookups_per_second </code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Host database hit rate </p></td>
+         <td><p> <i><code> proxy.node.hostdb.hit_ratio_avg_10s</code> </i></p>
+             <p> <i><code> proxy.cluster.hostdb.hit_ratio_avg_10s </code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p><strong> HTTP</strong></p></td>
+       </tr>
+       <tr>
+         <td><p> Total document bytes from client</p></td>
+         <td><p> <i><code> proxy.process.http.user_agent_response_document_total_size</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Total header bytes from client</p></td>
+         <td><p> <i><code> proxy.process.http.user_agent_response_header_total_size</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Total connections to client</p></td>
+         <td><p> <i><code> proxy.process.http.total_client_connections</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Client transactions in progress</p></td>
+         <td><p> <i><code> proxy.process.http.current_client_transactions</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Total document bytes from origin server</p></td>
+         <td><p> <i><code> proxy.process.http.origin_server_response_document_total_size</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Total header bytes from origin server</p></td>
+         <td><p> <i><code> proxy.process.http.origin_server_response_header_total_size</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Total connections to origin server</p></td>
+         <td><p> <i><code> proxy.process.http.total_server_connections</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Origin server transactions in progress </p></td>
+         <td><p> <i><code> proxy.process.http.current_server_transactions</code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p><strong> ICP</strong></p></td>
+       </tr>
+       <tr>
+         <td><p> ICP query requests originating from this node</p></td>
+         <td><p> <i><code> proxy.process.icp.icp_query_requests</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> ICP query messages sent from this node</p></td>
+         <td><p> <i><code> proxy.process.icp.total_udp_send_queries</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> ICP peer hit messages received from this node</p></td>
+         <td><p> <i><code> proxy.process.icp.icp_query_hits</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> ICP peer miss messages received from this node </p></td>
+         <td><p> <i><code> proxy.process.icp.icp_query_misses</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Total ICP responses received from this node</p></td>
+         <td><p> <i><code> proxy.process.icp.icp_remote_responses</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Average ICP message response time (ms) from this node</p></td>
+         <td><p> <i><code> proxy.process.icp.total_icp_response_time</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Average ICP request time (ms) from this node</p></td>
+         <td><p> <i><code> proxy.process.icp.total_icp_request_time</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Query messages received from ICP peers</p></td>
+         <td><p> <i><code> proxy.process.icp.icp_remote_query_requests</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Remote query hits from ICP peers</p></td>
+         <td><p> <i><code> proxy.process.icp.cache_lookup_success</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Remote query misses from ICP peers</p></td>
+         <td><p> <i><code> proxy.process.icp.cache_lookup_fail</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Successful response messages sent to peers</p></td>
+         <td><p> <i><code> proxy.process.icp.query_response_write</code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p><strong> Cache </strong></p></td>
+       </tr>
+       <tr>
+         <td><p> Bytes used</p></td>
+         <td><p> <i><code> proxy.process.cache.bytes_used</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Cache size</p></td>
+         <td><p> <i><code> proxy.process.cache.bytes_total</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Lookups in progress</p></td>
+         <td><p> <i><code> proxy.process.cache.lookup.active</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Lookups completed</p></td>
+         <td><p> <i><code> proxy.process.cache.lookup.success</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Lookup misses</p></td>
+         <td><p> <i><code> proxy.process.cache.lookup.failure</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Reads in progress</p></td>
+         <td><p> <i><code> proxy.process.cache.read.active</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Reads completed</p></td>
+         <td><p> <i><code> proxy.process.cache.read.success</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Read misses</p></td>
+         <td><p> <i><code> proxy.process.cache.read.failure</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Writes in progress</p></td>
+         <td><p> <i><code> proxy.process.cache.write.active</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Writes completed</p></td>
+         <td><p> <i><code> proxy.process.cache.write.success</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Write failures</p></td>
+         <td><p> <i><code> proxy.process.cache.write.failure</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Updates in progress</p></td>
+         <td><p> <i><code> proxy.process.cache.update.active</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Updates completed</p></td>
+         <td><p> <i><code> proxy.process.cache.update.success</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Update failures</p></td>
+         <td><p> <i><code> proxy.process.cache.update.failure</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Removes in progress</p></td>
+         <td><p> <i><code> proxy.process.cache.remove.active</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Remove successes</p></td>
+         <td><p> <i><code> proxy.process.cache.remove.success</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Remove failures</p></td>
+         <td><p> <i><code> proxy.process.cache.remove.failure</code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p> <strong> Host Database</strong> </p></td>
+       </tr>
+       <tr>
+         <td><p> Total lookups</p></td>
+         <td><p> <i><code> proxy.process.hostdb.total_lookups</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Total hits</p></td>
+         <td><p> <i><code> proxy.process.hostdb.total_hits</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Time TTL (min)</p></td>
+         <td><p> <i><code> proxy.process.hostdb.ttl</code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p> <strong> DNS</strong> </p></td>
+       </tr>
+       <tr>
+         <td><p> DNS total lookups</p></td>
+         <td><p> <i><code> proxy.process.dns.total_dns_lookups</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Average lookup time (ms)</p></td>
+         <td><p> <i><code> proxy.process.dns.lookup_avg_time</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> DNS successes</p></td>
+         <td><p> <i><code> proxy.process.dns.lookup_successes</code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p><strong> Cluster </strong></p></td>
+       </tr>
+       <tr>
+         <td><p> Bytes read</p></td>
+         <td><p> <i><code> proxy.process.cluster.read_bytes</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Bytes written</p></td>
+         <td><p> <i><code> proxy.process.cluster.write_bytes</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Connections open</p></td>
+         <td><p> <i><code> proxy.process.cluster.connections_open</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Total operations</p></td>
+         <td><p> <i><code> proxy.process.cluster.connections_opened</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Network backups</p></td>
+         <td><p> <i><code> proxy.process.cluster.net_backup</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Clustering nodes</p></td>
+         <td><p> <i><code> proxy.process.cluster.nodes</code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p><strong> Logging </strong></p></td>
+       </tr>
+       <tr>
+         <td><p> Currently open log files</p></td>
+         <td><p> <i><code> proxy.process.log2.log_files_open</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Space used for log files</p></td>
+         <td><p> <i><code> proxy.process.log2.log_files_space_used</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Number of access events logged</p></td>
+         <td><p> <i><code> proxy.process.log2.event_log_access</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Number of access events skipped</p></td>
+         <td><p> <i><code> proxy.process.log2.event_log_access_skip</code> </i></p></td>
+       </tr>
+       <tr>
+         <td><p> Number of error events logged</p></td>
+         <td><p> <i><code> proxy.process.log2.event_log_error</code> </i></p></td>
+       </tr>
+       <tr>
+         <td rowspan="1" colspan="2"><p><strong> Congestion Control</strong></p></td>
+       </tr>
+       <tr>
+         <td><p> Number of congestions Traffic Server has observed because the maximum number of connections were exceeded.</p></td>
+         <td><p> <i><code>proxy.process.congestion.congested_on_max_connection</code></i></p></td>
+       </tr>
+       <tr>
+         <td><p> Number of congestions Traffic Server has observed because of an operating system response or timeout failure.</p></td>
+         <td><p><i><code>proxy.process.congestion.congested_on_conn_failures</code></i></p></td>
+       </tr>
+     </table>
+
+</body>
 </html>
\ No newline at end of file

Modified: incubator/trafficserver/site/trunk/docs/admin/doc.css
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/doc.css?rev=833617&r1=833616&r2=833617&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/doc.css (original)
+++ incubator/trafficserver/site/trunk/docs/admin/doc.css Sat Nov  7 00:35:48 2009
@@ -1,8 +1,11 @@
-body{font-family:Times New Roman; width:580px;}
+body{
+	font-family:Tahoma, Geneva, sans-serif;
+	width:580px;
+}
 h1{font-family:Arial;}
 h2{border-style: solid none none; border-color: grey; border-width: 3px 0px 0px;font-family:Arial;}
 h3{font-family:Arial;}
 h5{font-family:Arial; padding: 5px 5px 5px 15px; background:url(http://us.i1.yimg.com/us.yimg.com/i/us/pim/bn/downbr1.gif) no-repeat left center;}
 code{padding:15px 0px;}
 table{border:thin solid;border-collapse:collapse;}
-td{border:thin solid grey;  border-top-style:solid;}
\ No newline at end of file
+td{border:thin solid grey;  border-top-style:solid;}



Mime
View raw message