Appendix C - Traffic Line Commands

This appendix contains the following sections:

Traffic Line Commands
Traffic Line Variables

Traffic Line Commands

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 table describes all the commands available in Traffic Line.

Command	Description
`traffic_line -b`	Bounces Traffic Server on the local node. Bouncing Traffic Server shuts down and immediately restarts the Traffic Server node.
`traffic_line -c`	Clears accumulated statistics on the local node.
`traffic_line -h`	Displays a list of Traffic Line commands.
`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. 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.
`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 for a list of the configuration variables you can specify.
`traffic_line -x`	Initiates a Traffic Server configuration file reread. Use this command after every configuration file modification.
`traffic_line -B`	Bounces all Traffic Server nodes in the cluster. Bouncing Traffic Server shuts down and immediately restarts Traffic Server, node-by-node.
`traffic_line -C`	Clears accumulated statistics on all nodes in the cluster.
`traffic_line -L`	Restarts the `traffic_manager` and `traffic_server` processes on the local node.
`traffic_line -M`	Restarts the `traffic_manager` process and the `traffic_server` process on all the nodes in a cluster.
`traffic_line -S`	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. For procedures about specifying the variables, refer to Viewing Statistics from Traffic Line and Configuring Traffic Server Using Traffic Line.

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`
Lookups completed	`proxy.process.cache.lookup.success`
Lookup misses	`proxy.process.cache.lookup.failure`
Reads in progress	`proxy.process.cache.read.active`
Reads completed	`proxy.process.cache.read.success`
Read misses	`proxy.process.cache.read.failure`
Writes in progress	`proxy.process.cache.write.active`
Writes completed	`proxy.process.cache.write.success`
Write failures	`proxy.process.cache.write.failure`
Updates in progress	`proxy.process.cache.update.active`
Updates completed	`proxy.process.cache.update.success`
Update failures	`proxy.process.cache.update.failure`
Removes in progress	`proxy.process.cache.remove.active`
Remove successes	`proxy.process.cache.remove.success`
Remove failures	`proxy.process.cache.remove.failure`
Host Database
Total lookups	`proxy.process.hostdb.total_lookups`
Total hits	`proxy.process.hostdb.total_hits`
Time TTL (min)	`proxy.process.hostdb.ttl`
DNS
DNS total lookups	`proxy.process.dns.total_dns_lookups`
Average lookup time (msec)	`proxy.process.dns.lookup_avg_time`
DNS successes	`proxy.process.dns.lookup_successes`
Cluster
Bytes read	`proxy.process.cluster.read_bytes`
Bytes written	`proxy.process.cluster.write_bytes`
Connections open	`proxy.process.cluster.connections_open`
Total operations	`proxy.process.cluster.connections_opened`
Network backups	`proxy.process.cluster.net_backup`
Clustering nodes	`proxy.process.cluster.nodes`
Logging
Log files currently open	`proxy.process.log2.log_files_open`
Space used for log files	`proxy.process.log2.log_files_space_used`
Number of access events logged	`proxy.process.log2.event_log_access`
Number of access events skipped	`proxy.process.log2.event_log_access_skip`
Number of error events logged	`proxy.process.log2.event_log_error`
Congestion 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`