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 2013/09/01 21:34:31 UTC
git commit: finishing up the cleanup of the admin guide
Updated Branches:
refs/heads/master 74e88decb -> a41512358
finishing up the cleanup of the admin guide
pretty much done with cleanup in the admin guide: We're missing a couple
of links here and there, and the warnings we get from the .. XXX: stuff
is on purpose, because it's broken, and needs retouching. Please either
leave it intact, or fix the documentation.
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/a4151235
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/a4151235
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/a4151235
Branch: refs/heads/master
Commit: a41512358e9f524058d4b68a0658b5c11cf804f6
Parents: 74e88de
Author: Igor Galić <i....@brainsware.org>
Authored: Sun Sep 1 21:32:44 2013 +0200
Committer: Igor Galić <i....@brainsware.org>
Committed: Sun Sep 1 21:32:44 2013 +0200
----------------------------------------------------------------------
doc/admin/event-logging-formats.en.rst | 10 +-
doc/admin/faqs.en.rst | 105 ++++++-------
doc/admin/traffic-server-error-messages.en.rst | 155 +++++++++----------
doc/admin/working-log-files.en.rst | 49 +++---
doc/admin/working-log-files/log-formats.en.rst | 4 +-
.../configuration/logs_xml.config.en.rst | 2 +
6 files changed, 148 insertions(+), 177 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a4151235/doc/admin/event-logging-formats.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/event-logging-formats.en.rst b/doc/admin/event-logging-formats.en.rst
index 8c48bd8..c4d1727 100644
--- a/doc/admin/event-logging-formats.en.rst
+++ b/doc/admin/event-logging-formats.en.rst
@@ -1,3 +1,5 @@
+.. _event-logging-formats:
+
Event Logging Formats
*********************
@@ -123,7 +125,7 @@ The following list describes Traffic Server custom logging fields.
In reverse proxy mode, Traffic Server logs the rewritten/mapped URL
(according to the rules in the
- :ref:`remap.config` file),
+ :file:`remap.config` file),
_not_ the pristine/unmapped URL.
``cquc``
@@ -321,9 +323,9 @@ Squid Logging Formats
The following is a list of the Squid logging fields and the
corresponding logging field symbols.
-===== =============
+================== =============
Squid Field Symbols
-===== =============
+================== =============
``time`` ``cqts``
``elapsed`` ``ttms``
``client`` ``chi``
@@ -334,7 +336,7 @@ Squid Field Symbols
``ident`` ``caun``
``hierarchy/from`` ``phr/pqsn``
``content`` ``psct``
-===== =============
+================== =============
Netscape Common Logging Formats
-------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a4151235/doc/admin/faqs.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/faqs.en.rst b/doc/admin/faqs.en.rst
index dfc566d..d8b0894 100644
--- a/doc/admin/faqs.en.rst
+++ b/doc/admin/faqs.en.rst
@@ -1,3 +1,5 @@
+.. _admin-faqs:
+
FAQ and Troubleshooting Tips
****************************
@@ -27,9 +29,9 @@ FAQs
How do you create a raw disk for the cache if all your disks have mounted file systems?
---------------------------------------------------------------------------------------
-Create a large file on filesystem (with ``dd``) and mount it as loopback device.
-This is accomplished with ``loosetup(8)`` on Linux, ``lofiadm(1m)`` on Solaris
-and Illumos, and ``mdconfig(8)`` on FreeBSD.
+Create a large file on filesystem (with :manpage`dd(1)`) and mount it as loopback device.
+This is accomplished with :manpage:`losetup(8)` on Linux, :manpage:`lofiadm(1m)` on Solaris
+and Illumos, and :manpage:`mdconfig(8)` on FreeBSD.
How do disk I/O errors affect the cache and what does Traffic Server do when a cache disk fails?
------------------------------------------------------------------------------------------------
@@ -61,27 +63,19 @@ Traffic Server does not execute the applets, scripts, or programs,
however - these objects run only when the client system (ie, the one
that sent the request) loads them.
-How do you apply changes to the ``logs_xml.config`` file to all nodes in a cluster?
------------------------------------------------------------------------------------
-
-Link to documentation
-
In Squid- and Netscape-format log files, what do the cache result codes mean?
-----------------------------------------------------------------------------
-This is described in detail in the `Squid log format
-documentation <../working-log-files/squid-format>`_
+This is described in detail in the :ref:`log-formats-squid-format`
What is recorded by the ``cqtx`` field in a custom log file?
------------------------------------------------------------
- In **forward proxy mode**, the cqtx field records the complete client
- request in the log file (for example, GET http://www.company.com
- HTTP/1.0 ).
+ request in the log file (for example, ``GET http://www.company.com HTTP/1.0``).
- In **reverse proxy mode**, the cqtx field records the hostname or IP
address of the origin server because Traffic Server first remaps the
- request as per map rules in the
- `remap.config <../configuration-files/remap.config>`_ file.
+ request as per map rules in the :file:`remap.config` file.
Does Traffic Server refresh entries in its host database after a certain period of time if they have not been used?
-------------------------------------------------------------------------------------------------------------------
@@ -94,9 +88,7 @@ to compare the ``ttl`` value set by the name server with the ``ttl``
value set by Traffic Server, and then use either the lower or the higher
value.
-see
-`proxy.config.hostdb.ttl_mode <../configuration-files/records.config#proxy.config.hostdb.ttl_mode>`_
-for more info
+see :ts:cv:`proxy.config.hostdb.ttl_mode` for more info
Can you improve the look of your custom response pages by using images, animated .gifs, and Java applets?
---------------------------------------------------------------------------------------------------------
@@ -113,27 +105,24 @@ Can Traffic Server run in forward proxy and reverse proxy modes at the same time
---------------------------------------------------------------------------------
Yes. When you enable reverse proxy mode, Traffic Server remaps incoming
-requests according to the map rules in the
-```remap.config`` <../configuration-files/remap.config>`_ file. All
+requests according to the map rules in the :file:`remap.config` file. All
other requests that do not match a map rule are simply served in forward
proxy mode.
If you want to run in reverse proxy only mode (wherein Traffic Server
does *not* serve requests that fail to match a map rule), then you must
-set the configuration variable
-`proxy.config.url_remap.remap_required <../configuration-files/records.config#proxy.config.url_remap.remap_required>`_
-to ``1`` in the
-`:file:`records.config` <../configuration-files/records.config>`_ file.
+set the configuration variable :ts:cv:`proxy.config.url_remap.remap_required`
+to ``1`` in the :file:`records.config` file.
How do I enable forward proxy mode
----------------------------------
-Please refer to the `Forward Proxy <../forward-proxy>`_ documentation
+Please refer to the :ref:`forward-proxy` documentation
How do I interpret the Via: header code?
----------------------------------------
-Take a look at our `Via decoder Ring </tools/via>`_
+Take a look at our `Via decoder Ring <http://trafficserver.apache.org/tools/via>`_
Support for HTTP Expect: Header
-------------------------------
@@ -177,26 +166,29 @@ You are unable to execute Traffic Line commands
Traffic Line commands do not execute under the following conditions:
-- **When the :program:`traffic_manager` process is not running** Check to see
- if the ``**traffic_manager**`` process is running by entering the
- following command: ``ps aux | grep traffic_manager``
+- **When the traffic_manager process is not running** Check to see
+ if the :program:`traffic_manager` process is running by entering the
+ following command: ``pgrep -l traffic_manager``
+
+ If the :program:`traffic_manager` process is not running, then enter the
+ following command from the Traffic Server ``bin`` directory to start it:
+ ``./traffic_manager``
+
+ .. this is wrong
+
+ You should always start and stop Traffic Server with the
+ :program:`trafficserver start`` and :program:`trafficserver stop` commands to ensure
+ that all the processes start and stop correctly. For more information,
+ refer to :ref:`getting-started`.
-If the :program:`traffic_manager` process is not running, then enter the
-following command from the Traffic Server ``bin`` directory to start it:
-``./traffic_manager``
+- **When you are not executing the command from $TSHome/bin** If the Traffic Server
+ ``bin`` directory is not in your path, then prepend the Traffic Line
+ commands with ``./`` (for example, ``./traffic_line -h``).
-.. this is wrong
+- **When multiple Traffic Server installations are present and you are not
+ executing the Traffic Line command from the active Traffic Server path
+ specified in ``/etc/trafficserver``**
-You should always start and stop Traffic Server with the
-``start_traffic_server``\ and ``stop_traffic_server`` commands to ensure
-that all the processes start and stop correctly. For more information,
-refer to `Getting Started <getstart.htm>`_. \* \* **When you are not
-executing the command from ``$TSHome/bin``** If the Traffic Server
-``bin`` directory is not in your path, then prepend the Traffic Line
-commands with ``./`` (for example, ``./traffic_line -h``). \* \* *\*
-When multiple Traffic Server installations are present and you are not
-executing the Traffic Line command from the active Traffic Server path
-specified in ``/etc/trafficserver``*\ \*
You observe inconsistent behavior when one node obtains an object from another node in the cluster
--------------------------------------------------------------------------------------------------
@@ -212,9 +204,8 @@ the latest version of xntpd, go to ``http://www.eecis.udel.edu/~ntp/``
Web browsers display an error document with a 'data missing' message
--------------------------------------------------------------------
-A message similar to the following might display in web browsers:
+A message similar to the following might display in web browsers: ::
-::
Data Missing
This document resulted from a POST operation and has expired from the cache. You can repost the form data to recreate the document by pressing the Reload button.
@@ -230,9 +221,8 @@ Traffic Server does not resolve any websites
--------------------------------------------
The browser indicates that it is contacting the host and then times out
-with the following message:
+with the following message: ::
-::
The document contains no data; Try again later, or contact the server's Administrator...
Make sure the system is configured correctly and that Traffic Server can
@@ -240,14 +230,14 @@ read the name resolution file:
- Check if the server can resolve DNS lookups by issuing the nslookup
command (for example, ``nslookup www.myhost.com``).
-- Check if the ``/etc/resolv.conf`` file contains valid IP addresses
+- Check if the :manpage:`resolv.conf(5)` file contains valid IP addresses
for your DNS servers.
-- On some systems, if the ``/etc/resolv.conf`` file is unreadable or
+- On some systems, if the :manpage:`resolv.conf(5)` file is unreadable or
has no name server entry, then the operating system uses
``localhost`` as a name server. Traffic Server, however, does not use
this convention. If you want to use ``localhost`` as a name server,
then you must add a name server entry for ``127.0.0.1`` or
- ``0.0.0.0`` in the ``/etc/resolv.conf`` file.
+ ``0.0.0.0`` in the :manpage:`resolv.conf(5)` file.
- Check that the Traffic Server user account has permission to read the
/etc/resolv.conf file. If it does not, then change the file
permissions to ``rw-r--r--`` (``644``)
@@ -255,25 +245,23 @@ read the name resolution file:
'Maximum document size exceeded' message in the system log file
---------------------------------------------------------------
-The following message appears in the system log file:
+The following message appears in the system log file: ::
-::
WARNING: Maximum document size exceeded
A requested object was larger than the maximum size allowed in the
Traffic Server cache, so Traffic Server provided proxy service for the
oversized object but did not cache it. To set the object size limit for
-the cache, modify the proxy.config.cache.limits.http.max_doc_size
+the cache, modify the :ts:cv:`proxy.config.cache.limits.http.max_doc_size`
variable in the records.config file. If you do not want to limit the
size of objects in the cache, then set the document size
-to\ ``**0**``\ (zero).
+to ``0`` (zero).
'DrainIncomingChannel' message in the system log file
-----------------------------------------------------
-The following messages may appear in the system log file:
+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:58 louis traffic_manager[4414]: ERROR ==> [drainIncomingChannel] Unknown message: 'GET http://www.ip.pt/ HTTP/1.0'
@@ -290,16 +278,15 @@ client machines have no access to the cluster ports.
'No cop file' message in the system log file
--------------------------------------------
-The following message appears repeatedly in the system log file:
+The following message appears repeatedly in the system log file: ::
-::
traffic_cop[16056]: encountered "var/trafficserver/no_cop" file...exiting
The file ``var/trafficserver/no_cop`` acts as an administrative control
that instructs the :program:`traffic_cop` process to exit immediately without
starting :program:`traffic_manager` or performing any health checks. The
``no_cop`` file prevents Traffic Server from starting automatically when
-it has been stopped with the ``stop_traffic_server`` command. Without
+it has been stopped with the option:`trafficserver stop` 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 ::
@@ -367,7 +354,7 @@ Connection throttle events can occur under the following conditions:
If necessary, you can reset the maximum number of connections supported
by Traffic Server by editing the value of the
-``_proxy.config.net.connections_throttle _`` configuration variable in
+:ref:`proxy.config.net.connections_throttle` configuration variable in
the records.config file. Do not increase the connection throttle limit
unless the system has adequate memory to handle the client connections
required. A system with limited RAM might need a throttle limit lower
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a4151235/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 d05758a..276f94d 100644
--- a/doc/admin/traffic-server-error-messages.en.rst
+++ b/doc/admin/traffic-server-error-messages.en.rst
@@ -20,18 +20,8 @@ Error Messages
specific language governing permissions and limitations
under the License.
-This section contains the following sections:
-
-- `Traffic Server Error Messages <#TSErrorMessages>`_: describes the
- warning messages Traffic Server sends to the system log file.
-- `Traffic Server Alarm Messages <#TSAlarmMessages>`_: describes the
- alarm messages that may appear on Traffic Manager Monitor pages.
-- `HTML Messages Sent to Clients <#HTMLMessagesSentClients>`_:
- describes the HTML error messages Traffic Server sends to browser
- clients.
-- `Standard HTTP Response Messages <#StandardHTTPResponseMessages>`_:
- describes the standard HTTP response codes origin servers send to
- browser clients.
+.. toctree::
+ :maxdepth: 2
Traffic Server Error Messages
=============================
@@ -55,39 +45,40 @@ Traffic Server Process Fatal
Traffic Server Warnings
-----------------------
-*``Logfile``* ``error:`` *``error_number``*
+``<Logfile> error: error_number``
Generic logging error.
-``Bad cluster major version range`` *``version1-version2``* ``for node`` *``IP address``* ``connect failed``
+``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``
+``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.
-``Could not rename log`` *``filename``* to *``rolled filename``*
+``Could not rename log <filename> to <rolled filename``
System error when renaming log file during roll.
-``Did`` *``this_amount``* ``of backup; still to do`` *``remaining_amount``*
+``Did <this amount> of backup; still to do <remaining amount>``
Congestion is approaching.
-``Different clustering minor versions`` *``version1, version2``* ``for node`` *``IP address``* ``continuing``
+``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``
+``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>`_.
+ Refer to :ref:`event-logging-formats`.
``Missing field for field marker``
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``*
+``Error accessing disk <disk name>``
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``
+``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.
@@ -100,15 +91,15 @@ Traffic Server Warnings
Traffic Server Alarm Messages
=============================
-``[Rollback::Rollback] Config file is read-only:`` *``filename``*
+``[Rollback::Rollback] Config file is read-only: <filename>``
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``*
+``[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``*
+``[Traffic Manager] Configuration File Update Failed: <error number>``
Go to the Traffic Server ``config`` directory and check the
indicated file permissions; change if necessary.
@@ -128,15 +119,15 @@ Traffic Server Alarm Messages
To prevent this error, consider rolling log files more frequently
and enabling the autodelete feature.
-``Created zero length place holder for config file`` *``filename``*
+``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.
-``Traffic Server could not open logfile`` *``filename``*
+``Traffic Server could not open logfile <filename>``
Check permissions for the indicated file and the logging directory.
-``Traffic Server failed to parse line`` *``line_number``* ``of the logging config file`` *``filename``*
+``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.
@@ -152,16 +143,15 @@ Traffic Server returns detailed error messages to browser clients when
there are problems with the HTTP transactions requested by the browser.
These Traffic Server response messages correspond to standard HTTP
response codes, but provide more information. A list of the more
-frequently-encountered HTTP response codes is provided in `Standard HTTP
-Response Messages <#StandardHTTPResponseMessages>`_. You can customize
-the Traffic Server response messages, if desired.
+frequently-encountered HTTP response codes is provided in :ref:`Standard HTTP
+Response Messages`. You can customize the Traffic Server response messages, if desired.
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``* .
+ You are not allowed to access the document at location ``URL``.
``access#denied``
``Cache Read Error``
@@ -176,24 +166,25 @@ with corresponding HTTP response codes and customizable files.
``Content Length Required``
``400``
- Could not process this request because ``Content-Length`` was not
- specified.
+ 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.
+ 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``
+``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
+ ``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``
@@ -208,43 +199,38 @@ with corresponding HTTP response codes and customizable files.
``HTTP Version Not Supported``
``505``
- The origin server *``server_name``* is using an unsupported version
+ 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``*.
+ 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.
+ 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.
+ 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.
+ 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``* .
+ 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.
+ The host ``<server name>`` did not return the document ``URL`` correctly.
``response#bad_response``
``Not Cached``
@@ -255,14 +241,13 @@ with corresponding HTTP response codes and customizable files.
``Not Found on Accelerator``
``404``
- The request for *``URL``* on host *``server_name``* was not found.
+ 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.
+ The host ``<hostname>`` did not return the document ``URL`` correctly.
``response#bad_response``
``Proxy Authentication Required``
@@ -272,36 +257,32 @@ with corresponding HTTP response codes and customizable files.
``Server Hangup``
``502``
- The server *``hostname``* closed the connection before the
- transaction was completed.
+ 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``*.
+ 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.
+ 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``*.
+ Could not connect to the server ``<hostname>``.
``connect#failed_connect``
``Unknown Error``
``502``
- The host *``hostname``* did not return the document *``URL``*
- correctly.
+ 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
+ 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.
@@ -309,72 +290,76 @@ with corresponding HTTP response codes and customizable files.
``Unsupported URL Scheme``
``400``
- Cannot perform your request for the document *``URL``* because the
+ Cannot perform your request for the document ``URL`` because the
protocol scheme is unknown.
``request#scheme_unsupported``
+
+.. standard-http-response-messages:
+
Standard HTTP Response Messages
-------------------------------
The following standard HTTP response messages are provided for your
information.
-**``200``**
+``200``
OK
-**``202``**
+``202``
Accepted
-**``204``**
+``204``
No Content
-**``206``**
+``206``
Partial Content
-**``300``**
+``300``
Multiple Choices
-**``301``**
+``301``
Moved Permanently
-**``302``**
+``302``
Found
-**``303``**
+``303``
See Other
-**``304``**
+``304``
Not Modified
-**``400``**
+``400``
Bad Request
-**``401``**
+``401``
Unauthorized; retry
-**``403``**
+``403``
Forbidden
-**``404``**
+``404``
Not Found
-**``405``**
+``405``
Method Not Allowed
-**``406``**
+``406``
Not acceptable
-**``408``**
+``408``
Request Timeout
-**``500``**
+``500``
Internal server error
-**``501``**
+``501``
Not Implemented
-**``502``**
+``502``
Bad Gateway
-**``504``**
+``504``
Gateway Timeout
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a4151235/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 1da9284..ae03c98 100644
--- a/doc/admin/working-log-files.en.rst
+++ b/doc/admin/working-log-files.en.rst
@@ -267,6 +267,8 @@ Set standard log file format options by following the steps below:
.. XXX:: setting what values?
+.. _using-custom-log-formats:
+
Using the Custom Format
~~~~~~~~~~~~~~~~~~~~~~~
@@ -330,13 +332,9 @@ In order to accomplish this, we
2. :ts:cv:`proxy.config.log.custom_logs_enabled`
3. In the
:file:`logs_xml.config` file
-4. Add
- ```LogFormat`` <../configuration-files/logs_xml.config#LogFormat>`_,
- ```LogFilter`` <../configuration-files/logs_xml.config#LogFilters>`_,
- and
- ```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_
+4. Add :ref:`LogFormat`, :ref:`LogFilters`, and :ref:`LogObject`
specifications to the configuration file.
-5. Save and close the ``log``s_xml.config`` file.
+5. Save and close the :file:`logs_xml.config` file.
6. Run the command :option:`traffic_line -x` to apply your configuration
changes.
@@ -351,8 +349,7 @@ period of time. This can significantly reduce the size of the log files
generated.
To generate a summary log file, create a
-```LogFormat`` <../configuration-files/logs_xml.config#LogFormat>`_
-object in the XML-based logging configuration file
+:ref:`LogFormat` object in the XML-based logging configuration file
(:file:`logs_xml.config`) using
the SQL-like aggregate operators below. You can apply each of these
operators to specific fields, over a specified interval.
@@ -448,8 +445,8 @@ calculate a rough metric that compares the two formats.
For standard log formats, select Binary or ASCII (refer to `Setting
Standard Log File Format Options`). For the custom log
format, specify ASCII or Binary mode in the
-```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_
-(refer to `Using the Custom Format <#UsingCustomFormat>`_). In addition
+:ref:`LogObject`
+(refer to :ref:`Using the Custom Format <using-custom-log-formats>`). In addition
to the ASCII and binary options, you can also write custom log entries
to a UNIX-named pipe (i.e., a buffer in memory). Other processes can
then read the data using standard I/O functions. The advantage of using
@@ -585,11 +582,11 @@ log files when they reach a certain size, follow the steps below:
changes.
You can fine-tune log file rolling settings for a custom log file in the
-```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_
+:ref:`LogObject`
specification in the
:file:`logs_xml.config` file.
The custom log file uses the rolling settings in its
-```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_,
+:ref:`LogObject`,
which override the default settings you specify in Traffic Manager or
the :file:`records.config` file described above.
@@ -617,12 +614,11 @@ HTTP Host Log Splitting
HTTP host log splitting enables you to record HTTP transactions for
different origin servers in separate log files. When HTTP host log
splitting is enabled, Traffic Server creates a separate log file for
-each origin server that's listed in the
-```log_hosts.config`` <#EditingLogHostsConfigFile>`_ file. When both ICP
-and HTTP host log splitting are enabled, Traffic Server generates
+each origin server that's listed in the :file:`log_hosts.config` file.
+When both ICP and HTTP host log splitting are enabled, Traffic Server generates
separate log files for HTTP transactions (based on the origin server)
and places all ICP transactions in their own respective log files. For
-example, if the ``log_hosts.config`` file contains the two origin
+example, if the :file:`log_hosts.config` file contains the two origin
servers ``uni.edu`` and ``company.com`` and Squid format is enabled,
then Traffic Server generates the following log files:
@@ -743,16 +739,16 @@ To configure Traffic Server to collate event log files, you must perform
the following tasks:
- Either `Configure Traffic Server Node to Be a Collation
- Server <#ConfiguringTSCollationServer>`_ or install & configure a
- `Standalone Collator <#UsingStandaloneCollator>`_.
+ Server <Configuring Traffic Server to Be a Collation Server>`_ or install & configure a
+ `Standalone Collator <Using a Standalone Collator>`_
- `Configure Traffic Server Nodes to Be a Collation
- Clients <#ConfiguringTSCollationClient>`_.
+ Clients <Configuring Traffic Server to Be a Collation Server>`_.
- Add an attribute to the
- ```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_
+ :ref:`LogObject`
specification in the
:file:`logs_xml.config` file
if you are using custom log file formats; refer to `Collating Custom
- Event Log Files <#CollatingCustomEventLogFiles>`_.
+ Event Log Files`_.
Configuring Traffic Server to Be a Collation Server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -826,7 +822,7 @@ been established, then you must restart Traffic Server.
- :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`
- file; refer to `Using the Custom Format <#UsingCustomFormat>`_.
+ file; refer to :ref:`Using the Custom Format <using-custom-log-formats>`.
- :ts:cv:`proxy.config.log.collation_host`
- :ts:cv:`proxy.config.log.collation_port`
- :ts:cv:`proxy.config.log.collation_secret`
@@ -847,12 +843,9 @@ To collate custom event log files
1. On each collation client, edit the `:file:`logs_xml.config`
2. Add the
- ```CollationHosts`` <../configuration-files/logs_xml.config#LogsXMLObjectCollationHosts>`_
- attribute to the
- ```LogObject`` <../configuration-files/logs_xml.config#LogsXMLObjects>`_
- specification:
-
- ::
+ :ref:`CollationHost <logs-xml-logobject-collationhost>` attribute to the
+ :ref:`LogObject`
+ specification: ::
<LogObject>
<Format = "squid"/>
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a4151235/doc/admin/working-log-files/log-formats.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/working-log-files/log-formats.en.rst b/doc/admin/working-log-files/log-formats.en.rst
index d3aad99..4a1a286 100644
--- a/doc/admin/working-log-files/log-formats.en.rst
+++ b/doc/admin/working-log-files/log-formats.en.rst
@@ -20,6 +20,8 @@ Log Formats
specific language governing permissions and limitations
under the License.
+.. _log-formats-squid-format:
+
Squid Format
============
@@ -45,7 +47,7 @@ Squid Format
The cache result code; how the cache responded to the request:
``HIT``, ``MISS``, and so on. Cache result codes are described
:ref:`here <squid-netscape-result-codes>`.
- The proxy response status code (the HTTP response status code from
+ The proxy response status code (the HTTP response status code from
Traffic Server to client).
``5``
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a4151235/doc/reference/configuration/logs_xml.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/logs_xml.config.en.rst b/doc/reference/configuration/logs_xml.config.en.rst
index f1796b9..1d2a057 100644
--- a/doc/reference/configuration/logs_xml.config.en.rst
+++ b/doc/reference/configuration/logs_xml.config.en.rst
@@ -215,6 +215,8 @@ The following list shows the ``LogObject`` specifications.
A comma-separated list of valid hostnames.This tag indicates that
only entries from the named servers will be included in the file.
+.. _logs-xml-logobject-collationhost:
+
``<CollationHosts = "list_of_valid_hostnames"/>``
Optional
A comma-separated list of collation servers to which all log entries