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/03/08 18:47:23 UTC
svn commit: r1079448 -
/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/traffic-line-commands/index.en.mdtext
Author: igalic
Date: Tue Mar 8 17:47:22 2011
New Revision: 1079448
URL: http://svn.apache.org/viewvc?rev=1079448&view=rev
Log:
Fixing up markdown formatting of traffic line document
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/traffic-line-commands/index.en.mdtext
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/traffic-line-commands/index.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/traffic-line-commands/index.en.mdtext?rev=1079448&r1=1079447&r2=1079448&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/traffic-line-commands/index.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/traffic-line-commands/index.en.mdtext Tue Mar 8 17:47:22 2011
@@ -15,846 +15,349 @@ Notice: Licensed to the Apache Softwa
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
+Navigation: [Next](*)
+ [SDK](../sdk/index.en.html)
-# Appendix C - Traffic Line Commands # {#AppendixC-TrafficLineCommands}
+# Traffic Line Commands # {#TrafficLineCommands}
- This appendix contains the following sections:
+ This section contains the following sections:
-* [Traffic Line Commands](#1053987)
-* [Traffic Line Variables](#1025718)
+* [Traffic Line Commands](#TrafficLineCommands)
+* [Traffic Line Variables](#TrafficLineVariables)
-## Traffic Line Commands ## {#TrafficLineCommands}
+## Traffic Line Commands ## {#TrafficLineCommands}
-
+ Use Traffic Line to execute individual Traffic Server commands and to script
+multiple commands in a shell. Execute Traffic Line commands from the Traffic
+Server `bin` directory. If the Traffic Server `bin` directory is not in your
+path, then prepend the Traffic Line command with `./` (for example:
+`./traffic_line -p`).
- Use Traffic Line to execute individual Traffic Server commands and to script
-multiple commands in a shell. Execute Traffic Line commands from the Traffic
-Server `bin` directory. If the Traffic Server `bin` directory is not in your
-path, then prepend the Traffic Line command with `./` (for example: `./traffic_line
--p`).
+The following list describes all the commands available in Traffic Line.
-
+`traffic_line -b`
+: Bounces Traffic Server on the local node. Bouncing Traffic Server shuts down
+ and immediately restarts the Traffic Server node.
- The following table describes all the commands available in Traffic Line.
-
+`traffic_line -c`
+: Clears accumulated statistics on the local node.
- **
+`traffic_line -h`
+: Displays a list of Traffic Line commands.
- Command
+`traffic_line -p` _`socket_path`_
+: Specifies location (directory and path) of the socket used for Traffic Line communication.
+ The default path is: _`install_dir`_`/config/cli`
-** **
+`traffic_line -q`
+: Displays a list of the origin servers that are currently congested.
- Description
+ **Note:** To use this command, you must set the variable _`proxy.config.raf.enabled`_
+ to `1` and set the variable _`proxy.config.raf.port`_ to a different port
+ _only_ if there is a conflict with the default port `9000`.
-**
+`traffic_line -r _variable_`
+: Displays specific performance statistics or a current configuration setting.
+ For a list of the variables you can specify, see [Traffic Line Variables](cli.htm#1025718).
- ` traffic_line -b`
+`traffic_line -s` _`variable`_ `-v` _`value`_
+: Sets configuration variables, where _`variable`_ is the configuration variable
+ you want to change and _`value`_ is the value you want to set. Refer to [records.config](../configuration-files/records.config)
+ for a list of the configuration variables you can specify.
-:
-
- Bounces Traffic Server on the local node. Bouncing Traffic Server shuts down
- and immediately restarts the Traffic Server node.
-
-
+`traffic_line -x`
+: Initiates a Traffic Server configuration file reread. Use this command after
+ every configuration file modification.
- ` traffic_line -c`
+`traffic_line -B`
+: Bounces all Traffic Server nodes in the cluster. Bouncing Traffic Server shuts
+ down and immediately restarts Traffic Server, node-by-node.
-:
-
- Clears accumulated statistics on the local node.
-
-
+`traffic_line -C`
+: Clears accumulated statistics on all nodes in the cluster.
- ` traffic_line -h`
+`traffic_line -L`
+: Restarts the `traffic_manager` and `traffic_server` processes on the local
+ node.
-:
-
- Displays a list of Traffic Line commands.
-
-
+`traffic_line -M`
+: Restarts the `traffic_manager` process and the `traffic_server` process
+ on all the nodes in a cluster.
- ` traffic_line -p _socket_path_`
+`traffic_line -S`
+: Shuts down Traffic Server on the local node.
-:
-
- Specifies location (directory and path) of the socket used for Traffic Line communication.
- The default path is: `_install_dir_ /config/cli`
-
-
+`traffic_line -U`
+: Starts Traffic Server on the local node.
- ` traffic_line -q`
-:
-
- Displays a list of the origin servers that are currently congested.
-
-
-
-
- **Note:** To use this command, you must set the variable ` _proxy.config.raf.enabled_`
- to 1 and set the variable ` _proxy.config.raf.port_` to a different port _
- only_ if there is a conflict with the default port 9000.
-
-
- ` traffic_line -r _variable_`
+# Traffic Line Variables # {#TrafficLineVariables}
-:
-
- Displays specific performance statistics or a current configuration setting.
- For a list of the variables you can specify, see [Traffic Line Variables](cli.htm#1025718).
-
-
-
+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 [records.config](files.htm#records.config). For procedures about
+specifying the variables, refer to [Viewing Statistics from Traffic Line](monitor.htm)
+and [Configuring Traffic Server Using Traffic Line](configure.htm).
- ` traffic_line -s _variable_ -v _value_`
+ The variables used for viewing individual statistics are described in the
+following table. To view a statistic in Traffic Line, enter the command
+`traffic_line -r` _`variable`_ at the prompt.
-:
-
- Sets configuration variables, where `_variable_` is the configuration variable
- you want to change and ` _value_` is the value you want to set. Refer to [records.config](files.htm#records.config)
- for a list of the configuration variables you can specify.
-
-
+### Summary ### {#TLVarsSummary}
- ` traffic_line -x`
+Node name
+: _`proxy.node.hostname`_
-:
-
- Initiates a Traffic Server configuration file reread. Use this command after
- every configuration file modification.
-
-
+Objects served
+: _`proxy.node.user_agents_total_documents_served`_
- ` traffic_line -B`
+Transactions per second
+: _`proxy.node.user_agent_xacts_per_second`_
-:
-
- Bounces all Traffic Server nodes in the cluster. Bouncing Traffic Server shuts
- down and immediately restarts Traffic Server, node-by-node.
-
-
+### Node ### {#TLVarsNode}
- ` traffic_line -C`
+Document hit rate
+: _`proxy.node.cache_hit_ratio_avg\_10s`_
+: _`proxy.cluster.cache_hit_ratio_avg\_10s`_
-:
-
- Clears accumulated statistics on all nodes in the cluster.
-
-
-
- ` traffic_line -L`
-
-:
-
- Restarts the ` traffic_manager` and ` traffic_server` processes on the local
- node.
-
-
+Bandwidth savings
+: _`proxy.node.bandwidth_hit_ratio_avg\_10s`_
+: _`proxy.cluster.bandwidth_hit_ratio_avg\_10s`_
- ` traffic_line -M`
+Cache percent free
+: _`proxy.node.cache.percent_free`_
+: _`proxy.cluster.cache.percent_free`_
-:
-
- Restarts the ` traffic_manager` process and the ` traffic_server` process
- on all the nodes in a cluster.
-
-
+Open origin server connections
+: _`proxy.node.current_server_connections`_
+: _`proxy.cluster.current_server_connections`_
- ` traffic_line -S`
+Open client connections
+: _`proxy.node.current_client_connections`_
+: _`proxy.cluster.current_client_connections`_
-:
-
- Shuts down Traffic Server on the local node.
-
-
-
- ` traffic_line -U`
-
-:
-
- Starts Traffic Server on the local node.
-
-
-
- **Traffic Line Variables**
-
-
-
-
- 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 [records.config](files.htm#records.config). For procedures about
-specifying the variables, refer to [Viewing Statistics from Traffic Line](monitor.htm)
-and [Configuring Traffic Server Using Traffic Line](configure.htm).
-
- The variables used for viewing individual statistics are described in the
-following table. To view a statistic in Traffic Line, enter the command `traffic_line
--r _variable_ `at the prompt.
-
-
-
-** Statistic**
-
-:
-
- ** Variable**
-
-
-
-** Summary**
-
- Node name
-
-:
-
- _` proxy.node.hostname ` _
-
-
-
- Objects served
-
-:
-
- _` proxy.node.user_agents_total_documents_served` _
-
-
-
- Transactions per second
-
-:
-
- _` proxy.node.user_agent_xacts_per_second` _
-
-
-
-** Node**
-
- Document hit rate
-
-:
-
- _` proxy.node.cache_hit_ratio_avg_10s` _
-
-
-
-
- _` proxy.cluster.cache_hit_ratio_avg_10s` _
-
-
-
- Bandwidth savings
-
-:
-
- _` proxy.node.bandwidth_hit_ratio_avg_10s` _
-
-
-
-
- _` proxy.cluster.bandwidth_hit_ratio_avg_10s ` _
-
-
-
- Cache percent free
-
-:
-
- _` proxy.node.cache.percent_free` _
-
-
-
-
- _` proxy.cluster.cache.percent_free` _
-
-
-
- Open origin server connections
-
-:
-
- _` proxy.node.current_server_connections` _
-
-
-
-
- _` proxy.cluster.current_server_connections ` _
-
-
-
- Open client connections
-
-:
-
- _` proxy.node.current_client_connections` _
-
-
-
-
- _` proxy.cluster.current_client_connections ` _
-
-
-
- Cache transfers in progress
-
-:
-
- _` proxy.node.current_cache_connections` _
-
-
-
-
- _` proxy.cluster.current_cache_connections ` _
-
-
-
- Client throughput (Mbits/sec)
-
-:
-
- _` proxy.node.client_throughput_out` _
-
-
-
-
- _` proxy.cluster.client_throughput_out` _
-
-
-
- Transactions per second
-
-:
-
- _` proxy.node.user_agent_xacts_per_second ` _
-
-
-
-
- _` proxy.cluster.user_agent_xacts_per_second` _
-
-
-
- DNS lookups per second
-
-:
-
- _` proxy.node.dns.lookups_per_second ` _
-
-
-
-
- _` proxy.cluster.dns.lookups_per_second ` _
-
-
-
- Host database hit rate
-
-:
-
- _` proxy.node.hostdb.hit_ratio_avg_10s` _
-
-
-
-
- _` proxy.cluster.hostdb.hit_ratio_avg_10s ` _
-
-
-
-** HTTP**
-
- Total document bytes from client
-
-:
-
- _` proxy.process.http.user_agent_response_document_total_size` _
-
-
-
- Total header bytes from client
-
-:
-
- _` proxy.process.http.user_agent_response_header_total_size` _
-
-
-
- Total connections to client
-
-:
-
- _` proxy.process.http.total_client_connections` _
-
-
-
- Client transactions in progress
-
-:
-
- _` proxy.process.http.current_client_transactions` _
-
-
-
- Total document bytes from origin server
-
-:
-
- _` proxy.process.http.origin_server_response_document_total_size` _
-
-
-
- Total header bytes from origin server
-
-:
-
- _` proxy.process.http.origin_server_response_header_total_size` _
-
-
-
- Total connections to origin server
-
-:
-
- _` proxy.process.http.total_server_connections` _
-
-
-
- Origin server transactions in progress
-
-:
-
- _` proxy.process.http.current_server_transactions` _
-
-
-
-** ICP**
-
- ICP query requests originating from this node
-
-:
-
- _` proxy.process.icp.icp_query_requests` _
-
-
-
- ICP query messages sent from this node
-
-:
-
- _` proxy.process.icp.total_udp_send_queries` _
-
-
-
- ICP peer hit messages received from this node
-
-:
-
- _` proxy.process.icp.icp_query_hits` _
-
-
-
- ICP peer miss messages received from this node
-
-:
-
- _` proxy.process.icp.icp_query_misses` _
-
-
-
- Total ICP responses received from this node
-
-:
-
- _` proxy.process.icp.icp_remote_responses` _
-
-
-
- Average ICP message response time (ms) from this node
-
-:
-
- _` proxy.process.icp.total_icp_response_time` _
-
-
-
- Average ICP request time (ms) from this node
-
-:
-
- _` proxy.process.icp.total_icp_request_time` _
-
-
-
- Query messages received from ICP peers
-
-:
-
- _` proxy.process.icp.icp_remote_query_requests` _
-
-
-
- Remote query hits from ICP peers
-
-:
-
- _` proxy.process.icp.cache_lookup_success` _
-
-
-
- Remote query misses from ICP peers
-
-:
-
- _` proxy.process.icp.cache_lookup_fail` _
-
-
-
- Successful response messages sent to peers
-
-:
-
- _` proxy.process.icp.query_response_write` _
-
-
-
-** Cache **
-
- Bytes used
-
-:
-
- _` proxy.process.cache.bytes_used` _
-
-
-
- Cache size
-
-:
-
- _` proxy.process.cache.bytes_total` _
-
-
-
- Lookups in progress
-
-:
-
- _` proxy.process.cache.lookup.active` _
-
-
+Cache transfers in progress
+: _`proxy.node.current_cache_connections`_
+: _`proxy.cluster.current_cache_connections`_
- Lookups completed
+Client throughput (Mbits/sec)
+: _`proxy.node.client_throughput_out`_
+: _`proxy.cluster.client_throughput_out`_
-:
-
- _` proxy.process.cache.lookup.success` _
-
-
+Transactions per second
+: _`proxy.node.user_agent_xacts_per_second`_
+: _`proxy.cluster.user_agent_xacts_per_second`_
- Lookup misses
+DNS lookups per second
+: _`proxy.node.dns.lookups_per_second`_
+: _`proxy.cluster.dns.lookups_per_second`_
-:
-
- _` proxy.process.cache.lookup.failure` _
-
-
+Host database hit rate
+: _`proxy.node.hostdb.hit_ratio_avg\_10s`_
+: _`proxy.cluster.hostdb.hit_ratio_avg\_10s`_
- Reads in progress
-:
-
- _` proxy.process.cache.read.active` _
-
-
+### HTTP ### {#TLVarsHTTP}
- Reads completed
+Total document bytes from client
+: _`proxy.process.http.user_agent_response_document_total_size`_
-:
-
- _` proxy.process.cache.read.success` _
-
-
+Total header bytes from client
+: _`proxy.process.http.user_agent_response_header_total_size`_
- Read misses
+Total connections to client
+: _`proxy.process.http.total_client_connections`_
-:
-
- _` proxy.process.cache.read.failure` _
-
-
+Client transactions in progress
+: _`proxy.process.http.current_client_transactions`_
- Writes in progress
+Total document bytes from origin server
+: _`proxy.process.http.origin_server_response_document_total_size`_
-:
-
- _` proxy.process.cache.write.active` _
-
-
+Total header bytes from origin server
+: _`proxy.process.http.origin_server_response_header_total_size`_
- Writes completed
+Total connections to origin server
+: _`proxy.process.http.total_server_connections`_
-:
-
- _` proxy.process.cache.write.success` _
-
-
+Origin server transactions in progress
+: _`proxy.process.http.current_server_transactions`_
- Write failures
-:
-
- _` proxy.process.cache.write.failure` _
-
-
+### ICP ### {#TLVarsICP}
- Updates in progress
+ICP query requests originating from this node
+: _`proxy.process.icp.icp_query_requests`_
-:
-
- _` proxy.process.cache.update.active` _
-
-
+ICP query messages sent from this node
+: _`proxy.process.icp.total_udp_send_queries`_
- Updates completed
+ICP peer hit messages received from this node
+: _`proxy.process.icp.icp_query_hits`_
-:
-
- _` proxy.process.cache.update.success` _
-
-
- Update failures
+ICP peer miss messages received from this node
+: _`proxy.process.icp.icp_query_misses`_
-:
-
- _` proxy.process.cache.update.failure` _
-
-
- Removes in progress
+Total ICP responses received from this node
+: _`proxy.process.icp.icp_remote_responses`_
-:
-
- _` proxy.process.cache.remove.active` _
-
-
+Average ICP message response time (ms) from this node
+: _`proxy.process.icp.total_icp_response_time`_
- Remove successes
-:
-
- _` proxy.process.cache.remove.success` _
-
-
+Average ICP request time (ms) from this node
+: _`proxy.process.icp.total_icp_request_time`_
- Remove failures
+Query messages received from ICP peers
+: _`proxy.process.icp.icp_remote_query_requests`_
-:
-
- _` proxy.process.cache.remove.failure` _
-
-
- ** Host Database**
- Total lookups
+Remote query hits from ICP peers
+: _`proxy.process.icp.cache_lookup_success`_
-:
-
- _` proxy.process.hostdb.total_lookups` _
-
-
- Total hits
+Remote query misses from ICP peers
+: _`proxy.process.icp.cache_lookup_fail`_
-:
-
- _` proxy.process.hostdb.total_hits` _
-
-
+Successful response messages sent to peers
+: _`proxy.process.icp.query_response_write`_
- Time TTL (min)
-:
-
- _` proxy.process.hostdb.ttl` _
-
-
- ** DNS**
+### Cache ### {#TLVarsCache}
- DNS total lookups
+Bytes used
+: _`proxy.process.cache.bytes_used`_
-:
-
- _` proxy.process.dns.total_dns_lookups` _
-
-
+Cache size
+: _`proxy.process.cache.bytes_total`_
- Average lookup time (msec)
+Lookups in progress
+: _`proxy.process.cache.lookup.active`_
-:
-
- _` proxy.process.dns.lookup_avg_time` _
-
-
+ Lookups completed
+: _`proxy.process.cache.lookup.success`_
- DNS successes
+Lookup misses
+: _`proxy.process.cache.lookup.failure`_
-:
-
- _` proxy.process.dns.lookup_successes` _
-
-
+Reads in progress
+: _`proxy.process.cache.read.active`_
-** Cluster **
+Reads completed
+: _`proxy.process.cache.read.success`_
- Bytes read
+Read misses
+: _`proxy.process.cache.read.failure`_
-:
-
- _` proxy.process.cluster.read_bytes` _
-
-
+Writes in progress
+: _`proxy.process.cache.write.active`_
- Bytes written
+Writes completed
+: _`proxy.process.cache.write.success`_
-:
-
- _` proxy.process.cluster.write_bytes` _
-
-
+Write failures
+: _`proxy.process.cache.write.failure`_
- Connections open
+Updates in progress
+: _`proxy.process.cache.update.active`_
-:
-
- _` proxy.process.cluster.connections_open` _
-
-
+Updates completed
+: _`proxy.process.cache.update.success`_
- Total operations
+Update failures
+: _`proxy.process.cache.update.failure`_
-:
-
- _` proxy.process.cluster.connections_opened` _
-
-
+Removes in progress
+: _`proxy.process.cache.remove.active`_
- Network backups
+Remove successes
+: _`proxy.process.cache.remove.success`_
-:
-
- _` proxy.process.cluster.net_backup` _
-
-
+Remove failures
+: _`proxy.process.cache.remove.failure`_
- Clustering nodes
-:
-
- _` proxy.process.cluster.nodes` _
-
-
-** Logging **
+### Host Database ### {#TLVarsHostDatabase}
- Log files currently open
+Total lookups
+: _`proxy.process.hostdb.total_lookups`_
-:
-
- _` proxy.process.log.log_files_open` _
-
-
+Total hits
+: _`proxy.process.hostdb.total_hits`_
- Space used for log files
+Time TTL (min)
+: _`proxy.process.hostdb.ttl`_
-:
-
- _` proxy.process.log.log_files_space_used` _
-
-
- Number of access events logged
-:
-
- _` proxy.process.log.event_log_access` _
-
-
+### DNS ### {#TLVarsDNS}
- Number of access events skipped
+DNS total lookups
+: _`proxy.process.dns.total_dns_lookups`_
-:
-
- _` proxy.process.log.event_log_access_skip` _
-
-
+Average lookup time (msec)
+: _`proxy.process.dns.lookup_avg_time`_
- Number of error events logged
+DNS successes
+: _`proxy.process.dns.lookup_successes`_
-:
-
- _` proxy.process.log.event_log_error` _
-
-
-** Congestion Control**
+### Cluster ### {#TLVarsCluster}
- Number of congestions Traffic Server has observed because the maximum number
-of connections was exceeded.
+Bytes read
+: _`proxy.process.cluster.read_bytes`_
+Bytes written
+: _`proxy.process.cluster.write_bytes`_
-:
-
- _`proxy.process.congestion.congested_on_max_connection`_
-
-
+Connections open
+: _`proxy.process.cluster.connections_open`_
- Number of congestions Traffic Server has observed because of an OS response
-or timeout failure.
+Total operations
+: _`proxy.process.cluster.connections_opened`_
-:
-
- _`proxy.process.congestion.congested_on_conn_failures`_
-
-
-
-
-
-
-
-
-
-
-
-* [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.
+Network backups
+: _`proxy.process.cluster.net_backup`_
+Clustering nodes
+: _`proxy.process.cluster.nodes`_
+### Logging ### {#TLVarsLogging}
+
+Log files currently open
+: _`proxy.process.log.log_files_open`_
+
+Space used for log files
+: _`proxy.process.log.log_files_space_used`_
+
+Number of access events logged
+: _`proxy.process.log.event_log_access`_
+
+Number of access events skipped
+: _`proxy.process.log.event_log_access_skip`_
+
+Number of error events logged
+: _`proxy.process.log.event_log_error`_
+
+
+### Congestion Control ### {#TLVarsCongestion Control}
+
+Number of congestions Traffic Server has observed because the maximum number
+of connections was exceeded.
+: _`proxy.process.congestion.congested_on_max_connection`_
+
+
+
+Number of congestions Traffic Server has observed because of an OS response
+or timeout failure.
+: _`proxy.process.congestion.congested_on_conn_failures`_
+