Doc: Lots of little fixes so I can do my real work.
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/6fda8f91 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/6fda8f91 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/6fda8f91 Branch: refs/heads/5.0.x Commit: 6fda8f91144c315bc5c0c5384dcbb83bcea08547 Parents: b323fde Author: Alan M. Carroll <a...@network-geographics.com> Authored: Fri Aug 23 12:22:04 2013 -0500 Committer: Alan M. Carroll <a...@network-geographics.com> Committed: Fri Aug 23 12:22:04 2013 -0500 ---------------------------------------------------------------------- doc/admin/faqs.en.rst | 69 ++-- doc/admin/traffic-server-error-messages.en.rst | 404 +++++++++---------- doc/admin/transparent-proxy/bridge.en.rst | 111 ++--- doc/admin/working-log-files.en.rst | 54 +-- doc/reference/api/TSHttpTxnMilestoneGet.en.rst | 74 ++-- .../configuration/records.config.en.rst | 20 +- 6 files changed, 364 insertions(+), 368 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/6fda8f91/doc/admin/faqs.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/faqs.en.rst b/doc/admin/faqs.en.rst index 293fe7c..dfc566d 100644 --- a/doc/admin/faqs.en.rst +++ b/doc/admin/faqs.en.rst @@ -3,20 +3,20 @@ FAQ and Troubleshooting Tips .. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. .. toctree:: :maxdepth: 2 @@ -145,24 +145,19 @@ Note that clients such as cURL automatically send Expect: for POST requests with large POST bodies, with a 1 second timeout if a 100 Continue response is not received. To avoid the timeout when using cURL as a client to Traffic Server, you can turn off the Expect: header as -follows: - -command line: +follows:: -:: - curl -H"Expect:" http://www.example.com/ + curl -H"Expect:" http://www.example.com/ -C (libcurl): +C (libcurl):: -:: - struct curl_slist *header_list=NULL; - header_list = curl_slist_append(header_list, "Expect:"); - curl_easy_setopt(my_curlp, CURLOPT_HTTPHEADER, header_list); + struct curl_slist *header_list=NULL; + header_list = curl_slist_append(header_list, "Expect:"); + curl_easy_setopt(my_curlp, CURLOPT_HTTPHEADER, header_list); -php: +php:: -:: - curl_setopt($ch, CURLOPT_HTTPHEADER, array('Expect:')); + curl_setopt($ch, CURLOPT_HTTPHEADER, array('Expect:')); Troubleshooting Tips ==================== @@ -280,7 +275,7 @@ The following messages may appear in the system log file: :: Feb 20 23:53:40 louis traffic_manager[4414]: ERROR ==> [drainIncomingChannel] Unknown message: 'GET http://www.telechamada.pt/ HTTP/1.0' - Feb 20 23:53:46 louis last message repeated 1 time + Feb 20 23:53:46 louis last message repeated 1 time Feb 20 23:53:58 louis traffic_manager[4414]: ERROR ==> [drainIncomingChannel] Unknown message: 'GET http://www.ip.pt/ HTTP/1.0' These error messages indicate that a browser is sending HTTP requests to @@ -307,10 +302,9 @@ starting :program:`traffic_manager` or performing any health checks. The it has been stopped with the ``stop_traffic_server`` command. Without this static control, Traffic Server would restart automatically upon system reboot. The ``no_cop`` control keeps Traffic Server off until it -is explicitly restarted with the +is explicitly restarted with the :: -:: - trafficserver start + trafficserver start command. @@ -320,10 +314,9 @@ Warning in the system log file when manually editing vaddrs.config If you manually edit the vaddrs.config file as a non-root user, then Traffic Server issues a warning message in the system log file similar -to the following: +to the following:: -:: - WARNING: interface is ignored: Operation not permitted + WARNING: interface is ignored: Operation not permitted You can safely ignore this message; Traffic Server *does* apply your configuration edits. @@ -390,11 +383,13 @@ problems. In fact, RAM exhaustion can occur even if the system has plenty of free swap space. Symptoms of extreme memory exhaustion include the following messages in -the system log files (``/var/log/messages``): +the system log files (``/var/log/messages``):: -:: - WARNING: errno 105 is ENOBUFS (low on kernel memory), consider a memory upgrade `kernel: eth0: can't fill rx buffer (force 0)! - kernel: recvmsg bug: copied E01BA916 seq E01BAB22 + WARNING: errno 105 is ENOBUFS (low on kernel memory), consider a memory upgrade + + kernel: eth0: can't fill rx buffer (force 0)! + + kernel: recvmsg bug: copied E01BA916 seq E01BAB22 To avoid memory exhaustion, add more RAM to the system or reduce the load on Traffic Server. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/6fda8f91/doc/admin/traffic-server-error-messages.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/traffic-server-error-messages.en.rst b/doc/admin/traffic-server-error-messages.en.rst index b0e2e5d..d05758a 100644 --- a/doc/admin/traffic-server-error-messages.en.rst +++ b/doc/admin/traffic-server-error-messages.en.rst @@ -5,20 +5,20 @@ Error Messages .. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. This section contains the following sections: @@ -44,117 +44,106 @@ Traffic Server Process Fatal ============================ ``Accept port is not between 1 and 65535. Please check configuration`` - The port specified in the :file:`records.config` file that accepts - incoming HTTP requests is not valid. + The port specified in the :file:`records.config` file that accepts + incoming HTTP requests is not valid. ``Self loop is detected in parent proxy configuration`` - The name and port of the parent proxy match that of Traffic Server. - This creates a loop when Traffic Server attempts to send the request - to the parent proxy. + The name and port of the parent proxy match that of Traffic Server. + This creates a loop when Traffic Server attempts to send the request + to the parent proxy. Traffic Server Warnings ----------------------- *``Logfile``* ``error:`` *``error_number``* - Generic logging error. + Generic logging error. -``Bad cluster major version range`` *``version1-version2``* ``for node`` -*``IP address``* ``connect failed`` - Incompatible software versions causing a problem. +``Bad cluster major version range`` *``version1-version2``* ``for node`` *``IP address``* ``connect failed`` + Incompatible software versions causing a problem. ``Connect by disallowed client`` *``IP address``*\ ``, closing`` - The specified client is not allowed to connect to Traffic Server; - the client IP address is not listed in the ``ip_allow.config`` file. + The specified client is not allowed to connect to Traffic Server; + the client IP address is not listed in the ``ip_allow.config`` file. ``Could not rename log`` *``filename``* to *``rolled filename``* - System error when renaming log file during roll. + System error when renaming log file during roll. -``Did`` *``this_amount``* ``of backup; still to do`` -*``remaining_amount``* - Congestion is approaching. +``Did`` *``this_amount``* ``of backup; still to do`` *``remaining_amount``* + Congestion is approaching. -``Different clustering minor versions`` *``version1, version2``* -``for node`` *``IP address``* ``continuing`` - Incompatible software versions are causing a problem. +``Different clustering minor versions`` *``version1, version2``* ``for node`` *``IP address``* ``continuing`` + Incompatible software versions are causing a problem. ``Log format symbol`` *``symbol_name``* ``not found`` - Custom log format references a field symbol that does not exist. - Refer to `Event Logging Formats <logfmts.htm>`_. + Custom log format references a field symbol that does not exist. + Refer to `Event Logging Formats <logfmts.htm>`_. ``Missing field for field marker`` - Error reading a log buffer. + Error reading a log buffer. -``Unable to open log file`` -*``filename``*\ ``, errno=``\ *``error_number``* - Cannot open the log file. +``Unable to open log file`` *``filename``* ``, errno=`` *``error_number``* Cannot open the log file. ``Error accessing disk`` *``disk_name``* - Traffic Server might have a cache read problem. You might need to - replace the disk. + Traffic Server might have a cache read problem. You might need to + replace the disk. -``Too many errors accessing disk`` *``disk_name``* -``: declaring disk bad`` - Traffic Server is not using the cache disk because it encountered - too many errors. The disk might be corrupt and might have to be - replaced. +``Too many errors accessing disk`` *``disk_name``* ``: declaring disk bad`` + Traffic Server is not using the cache disk because it encountered + too many errors. The disk might be corrupt and might have to be + replaced. ``No cache disks specified in storage.config file: cache disabled`` - The Traffic Server ``storage.config`` file does not list any cache - disks; Traffic Server is running in proxy-only mode. You must add - the disks you want to use for the cache to the - `storage.config <../configuration-files/storage.config>`_ file. + The Traffic Server ``storage.config`` file does not list any cache + disks; Traffic Server is running in proxy-only mode. You must add + the disks you want to use for the cache to :file:`storage.config`. Traffic Server Alarm Messages ============================= ``[Rollback::Rollback] Config file is read-only:`` *``filename``* - Go to the Traffic Server ``config`` directory and check the - indicated file permissions; change if necessary. + Go to the Traffic Server ``config`` directory and check the + indicated file permissions; change if necessary. -``[Rollback::Rollback] Unable to read or write config file`` -*``filename``* - Go to the Traffic Server ``config`` directory and make sure the - indicated file exists. Check permissions and modify if necessary. +``[Rollback::Rollback] Unable to read or write config file`` *``filename``* + Go to the Traffic Server ``config`` directory and make sure the + indicated file exists. Check permissions and modify if necessary. -``[Traffic Manager] Configuration File Update Failed:`` -*``error_number``* - Go to the Traffic Server ``config`` directory and check the - indicated file permissions; change if necessary. +``[Traffic Manager] Configuration File Update Failed:`` *``error_number``* + Go to the Traffic Server ``config`` directory and check the + indicated file permissions; change if necessary. ``[Traffic Manager] Mgmt <==>Proxy conn. closed`` - An informational message to inform you that the :program:`traffic_server` - process is down. + An informational message to inform you that the :program:`traffic_server` + process is down. ``Access logging suspended - configured space allocation exhausted.`` - The space allocated to the event log files is full; you must either - increase the space or delete some log files so that access logging - to continue. To prevent this error, consider rolling log files more - frequently and enabling the autodelete feature. + The space allocated to the event log files is full; you must either + increase the space or delete some log files so that access logging + to continue. To prevent this error, consider rolling log files more + frequently and enabling the autodelete feature. ``Access logging suspended - no more space on the logging partition.`` - The entire partition containing the event logs is full; you must - delete or move some log files to enable access logging to continue. - To prevent this error, consider rolling log files more frequently - and enabling the autodelete feature. + The entire partition containing the event logs is full; you must + delete or move some log files to enable access logging to continue. + To prevent this error, consider rolling log files more frequently + and enabling the autodelete feature. ``Created zero length place holder for config file`` *``filename``* - Go to the Traffic Server ``config`` directory and check the - indicated file. If it is indeed zero in length, then use a backup - copy of the configuration file. + Go to the Traffic Server ``config`` directory and check the + indicated file. If it is indeed zero in length, then use a backup + copy of the configuration file. ``Traffic Server could not open logfile`` *``filename``* - Check permissions for the indicated file and the logging directory. + Check permissions for the indicated file and the logging directory. -``Traffic Server failed to parse line`` *``line_number``* -``of the logging config file`` *``filename``* - Check your custom log configuration file; there could be syntax - errors. Refer to `Custom Logging Fields <logfmts.htm#66912>`_ for - correct custom log format fields. +``Traffic Server failed to parse line`` *``line_number``* ``of the logging config file`` *``filename``* + Check your custom log configuration file; there could be syntax + errors. Refer to :ref:`custom-logging-fields` for correct custom log format fields. ``vip_config binary is not setuid root, manager will be unable to enable virtual ip addresses`` - The :program:`traffic_manager` process is not able to set virtual IP - addresses. You must ``setuid root``\ for the ``vip_config`` file in - the Traffic Server ``bin`` directory. + The :program:`traffic_manager` process is not able to set virtual IP + addresses. You must ``setuid root`` for the ``vip_config`` file in + the Traffic Server ``bin`` directory. HTML Messages Sent to Clients ============================= @@ -171,163 +160,158 @@ The following table lists the hard-coded Traffic Server HTTP messages, with corresponding HTTP response codes and customizable files. ``Access Denied`` - ``403`` - You are not allowed to access the document at location *``URL``* . - ``access#denied`` + ``403`` + You are not allowed to access the document at location *``URL``* . + ``access#denied`` ``Cache Read Error`` - ``500`` - Error reading from cache; please retry request. - ``cache#read_error`` + ``500`` + Error reading from cache; please retry request. + ``cache#read_error`` ``Connection Timed Out`` - ``504`` - Too much time has elapsed since the server has sent data. - ``timeout#inactivity`` + ``504`` + Too much time has elapsed since the server has sent data. + ``timeout#inactivity`` ``Content Length Required`` - ``400`` - Could not process this request because ``Content-Length`` was not - specified. - ``request#no_content_length`` + ``400`` + Could not process this request because ``Content-Length`` was not + specified. + ``request#no_content_length`` ``Cycle Detected`` - ``400`` - Your request is prohibited because it would cause an HTTP proxy - cycle. - ``request#cycle_detected`` - -``Forbidden`` - ``403`` - *``port_number``* is not an allowed port for SSL connections (you - have made a request for a secure SSL connection to a forbidden port - number). - ``access#ssl_forbidden`` + ``400`` + Your request is prohibited because it would cause an HTTP proxy + cycle. + ``request#cycle_detected`` + +``Forbidden 403`` *``port_number``* is not an allowed port for SSL connections (you have made a request for a secure SSL connection to a forbidden port number). ``access#ssl_forbidden`` ``Host Header Required`` - ``400`` - An attempt was made to transparently proxy your request, but this - attempt failed because your browser did not send an HTTP ``Host`` - header. Manually configure your browser to use - ``http://``\ *``proxy_name``*\ ``:``\ *``proxy_port``* as the HTTP - proxy. Alternatively, end users can upgrade to a browser that - supports the HTTP ``Host`` header field. - ``interception#no_host`` + ``400`` + An attempt was made to transparently proxy your request, but this + attempt failed because your browser did not send an HTTP ``Host`` + header. Manually configure your browser to use + ``http://``\ *``proxy_name``*\ ``:``\ *``proxy_port``* as the HTTP + proxy. Alternatively, end users can upgrade to a browser that + supports the HTTP ``Host`` header field. + ``interception#no_host`` ``Host Header Required`` - ``400`` - Because your browser did not send a ``Host`` HTTP header field, the - virtual host being requested could not be determined. To access the - website correctly, you must upgrade to a browser that supports the - HTTP ``Host`` header field. - ``request#no_host`` + ``400`` + Because your browser did not send a ``Host`` HTTP header field, the + virtual host being requested could not be determined. To access the + website correctly, you must upgrade to a browser that supports the + HTTP ``Host`` header field. + ``request#no_host`` ``HTTP Version Not Supported`` - ``505`` - The origin server *``server_name``* is using an unsupported version - of the HTTP protocol. - ``response#bad_version`` + ``505`` + The origin server *``server_name``* is using an unsupported version + of the HTTP protocol. + ``response#bad_version`` ``Invalid HTTP Request`` - ``400`` - Could not process this *``client_request``* HTTP method request for - *``URL``*. - ``request#syntax_error`` + ``400`` + Could not process this *``client_request``* HTTP method request for + *``URL``*. + ``request#syntax_error`` ``Invalid HTTP Response`` - ``502`` - The host *``server_name``* did not return the document *``URL``* - correctly. - ``response#bad_response`` + ``502`` + The host *``server_name``* did not return the document *``URL``* + correctly. + ``response#bad_response`` ``Malformed Server Response`` - ``502`` - The host *``server_name``* did not return the document *``URL``* - correctly. - ``response#bad_response`` + ``502`` + The host *``server_name``* did not return the document *``URL``* + correctly. + ``response#bad_response`` ``Malformed Server Response Status`` - ``502`` - The host *``server_name``* did not return the document *``URL``* - correctly. - ``response#bad_response`` + ``502`` + The host *``server_name``* did not return the document *``URL``* + correctly. + ``response#bad_response`` ``Maximum Transaction Time exceeded`` - ``504`` - Too much time has elapsed while transmitting document *``URL``* . - ``timeout#activity`` + ``504`` + Too much time has elapsed while transmitting document *``URL``* . + ``timeout#activity`` ``No Response Header From Server`` - ``502`` - The host *``server_name``* did not return the document *``URL``* - correctly. - ``response#bad_response`` + ``502`` + The host *``server_name``* did not return the document *``URL``* + correctly. + ``response#bad_response`` ``Not Cached`` - ``504`` - This document was not available in the cache, and you (the client) - only accept cached copies. - ``cache#not_in_cache`` + ``504`` + This document was not available in the cache, and you (the client) + only accept cached copies. + ``cache#not_in_cache`` ``Not Found on Accelerator`` - ``404`` - The request for *``URL``* on host *``server_name``* was not found. - Check the location and try again. - ``urlrouting#no_mapping`` + ``404`` + The request for *``URL``* on host *``server_name``* was not found. + Check the location and try again. + ``urlrouting#no_mapping`` ``NULL`` - ``502`` - The host *``hostname``* did not return the document *``URL``* - correctly. - ``response#bad_response`` + ``502`` + The host *``hostname``* did not return the document *``URL``* + correctly. + ``response#bad_response`` ``Proxy Authentication Required`` - ``407`` - Please log in with username and password. - ``access#proxy_auth_required`` + ``407`` + Please log in with username and password. + ``access#proxy_auth_required`` ``Server Hangup`` - ``502`` - The server *``hostname``* closed the connection before the - transaction was completed. - ``connect#hangup`` + ``502`` + The server *``hostname``* closed the connection before the + transaction was completed. + ``connect#hangup`` ``Temporarily Moved`` - ``302`` - The document you requested, *``URL``*, has moved to a new location. - The new location is *``new_URL``*. - ``redirect#moved_temporarily`` + ``302`` + The document you requested, *``URL``*, has moved to a new location. + The new location is *``new_URL``*. + ``redirect#moved_temporarily`` ``Transcoding Not Available`` - ``406`` - Unable to provide the document *``URL``* in the format requested by - your browser. - ``transcoding#unsupported`` + ``406`` + Unable to provide the document *``URL``* in the format requested by + your browser. + ``transcoding#unsupported`` ``Tunnel Connection Failed`` - ``502`` - Could not connect to the server *``hostname``*. - ``connect#failed_connect`` + ``502`` + Could not connect to the server *``hostname``*. + ``connect#failed_connect`` ``Unknown Error`` - ``502`` - The host *``hostname``* did not return the document *``URL``* - correctly. - ``response#bad_response`` + ``502`` + The host *``hostname``* did not return the document *``URL``* + correctly. + ``response#bad_response`` ``Unknown Host`` - ``500`` - Unable to locate the server named *``hostname``*; the server does - not have a DNS entry. Perhaps there is a misspelling in the server - name or the server no longer exists; double-check the name and try - again. - ``connect#dns_failed`` + ``500`` + Unable to locate the server named *``hostname``*; the server does + not have a DNS entry. Perhaps there is a misspelling in the server + name or the server no longer exists; double-check the name and try + again. + ``connect#dns_failed`` ``Unsupported URL Scheme`` - ``400`` - Cannot perform your request for the document *``URL``* because the - protocol scheme is unknown. - ``request#scheme_unsupported`` + ``400`` + Cannot perform your request for the document *``URL``* because the + protocol scheme is unknown. + ``request#scheme_unsupported`` Standard HTTP Response Messages ------------------------------- @@ -336,63 +320,61 @@ The following standard HTTP response messages are provided for your information. **``200``** - OK + OK **``202``** - Accepted + Accepted **``204``** - No Content + No Content **``206``** - Partial Content + Partial Content **``300``** - Multiple Choices + Multiple Choices **``301``** - Moved Permanently + Moved Permanently **``302``** - Found + Found **``303``** - See Other + See Other **``304``** - Not Modified + Not Modified **``400``** - Bad Request + Bad Request **``401``** - Unauthorized; retry + Unauthorized; retry **``403``** - Forbidden + Forbidden **``404``** - Not Found + Not Found **``405``** - Method Not Allowed + Method Not Allowed **``406``** - Not acceptable + Not acceptable **``408``** - Request Timeout + Request Timeout **``500``** - Internal server error + Internal server error **``501``** - Not Implemented + Not Implemented **``502``** - Bad Gateway + Bad Gateway **``504``** - Gateway Timeout - - + Gateway Timeout http://git-wip-us.apache.org/repos/asf/trafficserver/blob/6fda8f91/doc/admin/transparent-proxy/bridge.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/transparent-proxy/bridge.en.rst b/doc/admin/transparent-proxy/bridge.en.rst index 45d0074..266e72c 100644 --- a/doc/admin/transparent-proxy/bridge.en.rst +++ b/doc/admin/transparent-proxy/bridge.en.rst @@ -3,20 +3,20 @@ Inline on a Linux Bridge .. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. @@ -35,21 +35,21 @@ In our example of setting up bridge mode we will use a local address of 192.168.1.11/24 and interfaces ``eth0`` and ``eth1`` as the bridge interfaces (more detailed documentation is available `here <http://www.tldp.org/HOWTO/BRIDGE-STP-HOWTO/preparing-the-bridge.html>`_). -You may omit the '#' character and everything after it.:: +You may omit the '#' character and everything after it. :: - brctl addbr br0 # create bridge device - brctl stp br0 off # Disable spanning tree protocol - brctl addif br0 eth0 # Add eth0 to bridge - brctl addif br0 eth1 # Add eth1 to bridge + brctl addbr br0 # create bridge device + brctl stp br0 off # Disable spanning tree protocol + brctl addif br0 eth0 # Add eth0 to bridge + brctl addif br0 eth1 # Add eth1 to bridge - ifconfig eth0 0 0.0.0.0 # Get rid of interface IP addresses - ifconfig eth1 0 0.0.0.0 # ditto # Set the bridge IP address and enable it - ifconfig br0 192.168.1.11 netmask 255.255.255.0 up + ifconfig eth0 0 0.0.0.0 # Get rid of interface IP addresses + ifconfig eth1 0 0.0.0.0 # ditto # Set the bridge IP address and enable it + ifconfig br0 192.168.1.11 netmask 255.255.255.0 up If you have not already done so, remember to add a default route, such -as this one for a gateway of 192.168.1.1.:: +as this one for a gateway of 192.168.1.1. :: - ip route add default via 192.168.1.1 + ip route add default via 192.168.1.1 At this point it is a good idea to test connectivity to verify the basic bridge is functional. @@ -81,23 +81,23 @@ packet as being diverted to the bridge and not forwarded, and the that we can use standard device tests on them [1]_(#1). Although this example handles only port 80, other ports are the same except for the port value. Note also the port here is the port from the point of view -of the clients and origin servers, not the Traffic Server server port.:: +of the clients and origin servers, not the Traffic Server server port. :: - ebtables -t broute -F # Flush the table - # inbound traffic - ebtables -t broute -A BROUTING -p IPv4 --ip-proto tcp --ip-dport 80 \ - -j redirect --redirect-target DROP - # returning outbound traffic - ebtables -t broute -A BROUTING -p IPv4 --ip-proto tcp --ip-sport 80 \ - -j redirect --redirect-target DROP + ebtables -t broute -F # Flush the table + # inbound traffic + ebtables -t broute -A BROUTING -p IPv4 --ip-proto tcp --ip-dport 80 \ + -j redirect --redirect-target DROP + # returning outbound traffic + ebtables -t broute -A BROUTING -p IPv4 --ip-proto tcp --ip-sport 80 \ + -j redirect --redirect-target DROP Traffic Server operates at layer 3 so we need to use ``iptables`` to handle IP packets appropriately.:: - iptables -t mangle -A PREROUTING -i eth1 -p tcp -m tcp --dport 80 \ - -j TPROXY --on-ip 0.0.0.0 --on-port 8080 --tproxy-mark 1/1 - iptables -t mangle -A PREROUTING -i eth0 -p tcp -m tcp --sport 80 \ - -j MARK --set-mark 1/1 + iptables -t mangle -A PREROUTING -i eth1 -p tcp -m tcp --dport 80 \ + -j TPROXY --on-ip 0.0.0.0 --on-port 8080 --tproxy-mark 1/1 + iptables -t mangle -A PREROUTING -i eth0 -p tcp -m tcp --sport 80 \ + -j MARK --set-mark 1/1 At this point the directionality of the interfaces matters. For the example ``eth1`` is the inbound (client side) interface, while ``eth0`` @@ -115,8 +115,8 @@ the point of view of the clients and origin servers. Once the flows are marked we can force them to be delivered locally via the loopback interface via a policy routing table.:: - ip rule add fwmark 1/1 table 1 - ip route add local 0.0.0.0/0 dev lo table 1 + ip rule add fwmark 1/1 table 1 + ip route add local 0.0.0.0/0 dev lo table 1 The marking used is arbitrary but it must be consistent between ``iptables`` and the routing rule. The table number must be in the range @@ -138,35 +138,36 @@ Additional troubleshooting ~~~~~~~~~~~~~~~~~~~~~~~~~~ * Check to make sure that ``iptables`` is not filtering (blocking) -incoming HTTP connections. It is frequently the case that the default -tables prevent incoming HTTP. You can clear all filters with the -commands:: +incoming HTTP connections. - iptables -t filter --flush FORWARD - iptables -t filter --flush INPUT + It is frequently the case that the default tables prevent incoming HTTP. You can clear all filters with the + commands:: -That is a bit drastic and should only be used for testing / debugging. A -live system will likely need some filters in place but that is beyond -the scope of this document. If this fixes the problem, then your filter -set is too restrictive. + iptables -t filter --flush FORWARD + iptables -t filter --flush INPUT -Note that this problem will prevent the basic bridge (without ATS) from -allowing HTTP traffic through. + That is a bit drastic and should only be used for testing / debugging. A + live system will likely need some filters in place but that is beyond + the scope of this document. If this fixes the problem, then your filter + set is too restrictive. -* Verify that IP packet forwarding is enabled. You can check this with:: + Note that this problem will prevent the basic bridge (without ATS) from + allowing HTTP traffic through. - cat /proc/sys/net/ipv4/ip_forward +* Verify that IP packet forwarding is enabled. You can check this with:: -The output should be a non-zero value (usually '1'). If it is zero, you -can set it with:: + cat /proc/sys/net/ipv4/ip_forward - echo '1' > /proc/sys/net/ipv4/ip_forward + The output should be a non-zero value (usually '1'). If it is zero, you + can set it with:: -This can setting can be persisted by putting it in ``/etc/sysctl.conf``: :: + echo '1' > /proc/sys/net/ipv4/ip_forward - net/ipv4/ip_forward=1 + This can setting can be persisted by putting it in ``/etc/sysctl.conf``: :: + net/ipv4/ip_forward=1 +.. rubric:: Footnotes .. [1] The ``--redirect-target`` can be omitted, but then the ``iptables`` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/6fda8f91/doc/admin/working-log-files.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/working-log-files.en.rst b/doc/admin/working-log-files.en.rst index 98f9b31..6ec5aa9 100644 --- a/doc/admin/working-log-files.en.rst +++ b/doc/admin/working-log-files.en.rst @@ -5,20 +5,20 @@ Working with Log Files .. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. Traffic Server generates log files that contain information about every @@ -299,7 +299,7 @@ for each ``LogObject`` definition). ``LogFormat`` object). - The file mode: ``ASCII``, ``Binary``, or ``ASCII_PIPE``. The default is ``ASCII``. - The ``ASCII_PIPE`` mode writes log entries to a UNIX-named pipe + The ``ASCII_PIPE`` mode writes log entries to a UNIX-named pipe (a buffer in memory); other processes can then read the data using standard I/O functions. The advantage of this option is that Traffic Server does not have to write to disk, which frees disk @@ -372,11 +372,11 @@ To create a summary log file format, we :: :::xml - <LogFormat> - <Name = "summary"/> - <Format = "%<operator(field)> : %<operator(field)>"/> - <Interval = "n"/> - </LogFormat> + <LogFormat> + <Name = "summary"/> + <Format = "%<operator(field)> : %<operator(field)>"/> + <Interval = "n"/> + </LogFormat> where ``operator`` is one of the five aggregate operators (``COUNT``, ``SUM``, ``AVERAGE``, ``FIRST``, ``LAST``), ``field`` @@ -687,7 +687,7 @@ Squid format is enabled). To edit the :file:`log_hosts.config` file follow the steps below: -1. In the :file:`log_hosts.config` file, +1. In the :file:`log_hosts.config` file, enter the hostname of each origin server on a separate line in the file, e.g.: :: @@ -762,7 +762,7 @@ a configuration file via the steps below. 1. In the :file:`records.config` file, edit the following variables - - :ts:cv:`proxy.config.log.collation_mode` (``1`` for server mode) + - :ts:cv:`proxy.local.log.collation_mode` (``1`` for server mode) - :ts:cv:`proxy.config.log.collation_port` - :ts:cv:`proxy.config.log.collation_secret` @@ -800,7 +800,7 @@ To install and configure a standalone collator: 6. Copy the :file:`records.config` file from a Traffic Server node configured to be a log collation client to the ``config`` directory you created in Step 4 on the standalone collator. - The :file:`records.config` file contains the log collation secret and + The :file:`records.config` file contains the log collation secret and the port you specified when configuring Traffic Server nodes to be collation clients. The collation port and secret must be the same for all collation clients and servers. @@ -811,7 +811,7 @@ To install and configure a standalone collator: 8. Enter the following command:: - traffic_sac -c config + traffic_sac -c config Configuring Traffic Server to Be a Collation Client ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -823,15 +823,15 @@ been established, then you must restart Traffic Server. 1. In the :file:`records.config` file, edit the following variables: - - :ts:cv:`proxy.config.log.collation_mode`: ``2`` to configure this node as log collation client and send + - :ts:cv:`proxy.local.log.collation_mode`: ``2`` to configure this node as log collation client and send standard formatted log entries to the collation server. - For XML-based formatted log entries, see :file:`logs_xml.config` + For XML-based formatted log entries, see :file:`logs_xml.config` file; refer to `Using the Custom Format <#UsingCustomFormat>`_. - :ts:cv:`proxy.config.log.collation_host` - :ts:cv:`proxy.config.log.collation_port` - :ts:cv:`proxy.config.log.collation_secret` - :ts:cv:`proxy.config.log.collation_host_tagged` - - :ts:cv:`proxy.config.log.max_space_for_orphan_logs` + - :ts:cv:`proxy.config.log.max_space_mb_for_orphan_logs` 2. Run the command :option:`traffic_line -x` to apply the configuration changes. @@ -845,7 +845,7 @@ and collation clients). To collate custom event log files -1. On each collation client, edit the `:file:`logs_xml.config` +1. On each collation client, edit the `:file:`logs_xml.config` 2. Add the ```CollationHosts`` <../configuration-files/logs_xml.config#LogsXMLObjectCollationHosts>`_ attribute to the http://git-wip-us.apache.org/repos/asf/trafficserver/blob/6fda8f91/doc/reference/api/TSHttpTxnMilestoneGet.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSHttpTxnMilestoneGet.en.rst b/doc/reference/api/TSHttpTxnMilestoneGet.en.rst index 7384569..c7e6bb8 100644 --- a/doc/reference/api/TSHttpTxnMilestoneGet.en.rst +++ b/doc/reference/api/TSHttpTxnMilestoneGet.en.rst @@ -1,19 +1,19 @@ .. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. .. default-domain:: c @@ -40,28 +40,32 @@ storage, and is set upon success. The supported :type:`TSMilestonesType` milestone types are: -| -| -| :data:`TS_MILESTONE_UA_BEGIN` -| :data:`TS_MILESTONE_UA_READ_HEADER_DONE` -| :data:`TS_MILESTONE_UA_BEGIN_WRITE` -| :data:`TS_MILESTONE_UA_CLOSE` -| :data:`TS_MILESTONE_SERVER_FIRST_CONNECT` -| :data:`TS_MILESTONE_SERVER_CONNECT` -| :data:`TS_MILESTONE_SERVER_CONNECT_END` -| :data:`TS_MILESTONE_SERVER_BEGIN_WRITE` -| :data:`TS_MILESTONE_SERVER_FIRST_READ` -| :data:`TS_MILESTONE_SERVER_READ_HEADER_DONE` -| :data:`TS_MILESTONE_SERVER_CLOSE` -| :data:`TS_MILESTONE_CACHE_OPEN_READ_BEGIN` -| :data:`TS_MILESTONE_CACHE_OPEN_READ_END` -| :data:`TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN` -| :data:`TS_MILESTONE_CACHE_OPEN_WRITE_END` -| :data:`TS_MILESTONE_DNS_LOOKUP_BEGIN` -| :data:`TS_MILESTONE_DNS_LOOKUP_END` -| :data:`TS_MILESTONE_SM_START` -| :data:`TS_MILESTONE_SM_FINISH` -| :data:`TS_MILESTONE_LAST_ENTRY` +.. _txn-milestone-table: + +=============================================== ========== +Key Milestone +=============================================== ========== +:data:`TS_MILESTONE_UA_BEGIN` +:data:`TS_MILESTONE_UA_READ_HEADER_DONE` +:data:`TS_MILESTONE_UA_BEGIN_WRITE` +:data:`TS_MILESTONE_UA_CLOSE` +:data:`TS_MILESTONE_SERVER_FIRST_CONNECT` +:data:`TS_MILESTONE_SERVER_CONNECT` +:data:`TS_MILESTONE_SERVER_CONNECT_END` +:data:`TS_MILESTONE_SERVER_BEGIN_WRITE` +:data:`TS_MILESTONE_SERVER_FIRST_READ` +:data:`TS_MILESTONE_SERVER_READ_HEADER_DONE` +:data:`TS_MILESTONE_SERVER_CLOSE` +:data:`TS_MILESTONE_CACHE_OPEN_READ_BEGIN` +:data:`TS_MILESTONE_CACHE_OPEN_READ_END` +:data:`TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN` +:data:`TS_MILESTONE_CACHE_OPEN_WRITE_END` +:data:`TS_MILESTONE_DNS_LOOKUP_BEGIN` +:data:`TS_MILESTONE_DNS_LOOKUP_END` +:data:`TS_MILESTONE_SM_START` +:data:`TS_MILESTONE_SM_FINISH` +:data:`TS_MILESTONE_LAST_ENTRY` +=============================================== ========== Return values ============= http://git-wip-us.apache.org/repos/asf/trafficserver/blob/6fda8f91/doc/reference/configuration/records.config.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst index 08d081d..9e17988 100644 --- a/doc/reference/configuration/records.config.en.rst +++ b/doc/reference/configuration/records.config.en.rst @@ -269,6 +269,10 @@ Value Effect The number of threads for cluster communication. On heavy cluster, the number should be adjusted. It is recommend that take the thread CPU usage as a reference when adjusting. +.. ts:cv:: CONFIG proxy.config.clustger.ethernet_interface STRING + + Set the interface to use for cluster communications. + Local Manager ============= @@ -1300,6 +1304,7 @@ Logging Configuration The maximum amount of time before data in the buffer is flushed to disk. .. ts:cv:: CONFIG proxy.config.log.max_space_mb_for_logs INT 2000 + :metric: megabytes :reloadable: The amount of space allocated to the logging directory (in MB). @@ -1312,6 +1317,7 @@ Logging Configuration :ts:cv:`proxy.config.log.max_space_mb_for_orphan_logs` for maximum allowed log space. .. ts:cv:: CONFIG proxy.config.log.max_space_mb_for_orphan_logs INT 25 + :metric: megabytes :reloadable: The amount of space allocated to the logging directory (in MB) if this node is acting as a collation client. @@ -1324,9 +1330,10 @@ Logging Configuration when you enable full remote logging, and bump to the same size as proxy.config.log.max_space_mb_for_logs. .. ts:cv:: CONFIG proxy.config.log.max_space_mb_headroom INT 10 + :metric: megabytes :reloadable: - The tolerance for the log space limit (in bytes). If the variable `proxy.config.log.auto_delete_rolled_files`_ is set to ``1`` + The tolerance for the log space limit (in megabytes). If the variable :ts:cv:`proxy.config.log.auto_delete_rolled_files` is set to ``1`` (enabled), then autodeletion of log files is triggered when the amount of free space available in the logging directory is less than the value specified here. @@ -1424,6 +1431,10 @@ Logging Configuration The `Netscape extended log <../working-log-files/log-formats#NetscapeFormats>`_ file header text. +.. ts:cv:: CONFIG proxy.config.log.extended_log_is_ascii INT 0 + + Set whether the extend log is written as ASCII (text) or binary. + .. ts:cv:: CONFIG proxy.config.log.extended2_log_enabled INT 0 :reloadable: @@ -1482,7 +1493,7 @@ server, refer to `logs_xml.config <logs_xml.config>`_. .. note:: Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom formats. -.. ts:cv:: CONFIG proxy.confg.log.collation_host STRING NULL +.. ts:cv:: CONFIG proxy.config.log.collation_host STRING NULL The hostname of the log collation server. @@ -1552,8 +1563,11 @@ server, refer to `logs_xml.config <logs_xml.config>`_. .. ts:cv:: CONFIG proxy.config.http.slow.log.threshold INT 0 :reloadable: + :metric: milliseconds - The number of milliseconds before a slow connection's debugging stats are dumped. Specify ``1`` to enable or ``0`` to disable. + If set to a non-zero value :arg:`N` then any connection that takes longer than :arg:`N` milliseconds from accept to + completion will cause its timing stats to be written to the :ts:cv:`debugging log file + <proxy.config.output.logfile>`. This is identifying data about the transaction and all of the :ref:`transaction milestones <txn-milestone-table>`. Diagnostic Logging Configuration ================================
