trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From zw...@apache.org
Subject [01/50] git commit: clean up links&formatting in (most) logging related docs.
Date Fri, 30 Aug 2013 16:20:14 GMT
Updated Branches:
  refs/heads/5.0.x 812b668de -> a75ebb637


clean up links&formatting in (most) logging related docs.


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/0f585e99
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/0f585e99
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/0f585e99

Branch: refs/heads/5.0.x
Commit: 0f585e999f498f2108fe30a2610323097d67618c
Parents: 6a222f3
Author: Igor Galić <i.galic@brainsware.org>
Authored: Wed Aug 21 23:20:52 2013 +0200
Committer: Igor Galić <i.galic@brainsware.org>
Committed: Wed Aug 21 23:21:29 2013 +0200

----------------------------------------------------------------------
 doc/admin/event-logging-formats.en.rst          | 121 +++++---
 doc/admin/traffic-server-error-messages.en.rst  |   2 +
 doc/admin/working-log-files.en.rst              | 296 +++++++++----------
 doc/admin/working-log-files/log-formats.en.rst  |  31 +-
 .../configuration/logs_xml.config.en.rst        | 102 +++----
 5 files changed, 288 insertions(+), 264 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/0f585e99/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 2176dba..08d8272 100644
--- a/doc/admin/event-logging-formats.en.rst
+++ b/doc/admin/event-logging-formats.en.rst
@@ -18,15 +18,17 @@ Event Logging Formats
   specific language governing permissions and limitations
   under the License.
 
+This document provides a reference for all the different logging formats
+Traffic Server supports.
+Rather than just reading about those formats, you may also want to try our
+`online event log builder </logbuilder/>`_ for an interactive way of
+building and understanding log formats.
 
--  `Custom Logging Fields <#CustomLoggingFields>`_ provides descriptions
-   of logging fields.
--  `Logging Format Cross-Reference <#LoggingFormatCrossReference>`_
-   provides cross-references between Trafic Server logging fields and
-   Netscape & Squid logging fields (including Netscape Extended and
-   Extended-2 fields).
--  You may also try our `online event log builder </logbuilder/>`_ for
-   an interactive way of building and understanding log formats.
+
+.. toctree::
+   :maxdepth: 2
+
+.. _custom-logging-fields:
 
 Custom Logging Fields
 =====================
@@ -36,12 +38,12 @@ The following list describes Traffic Server custom logging fields.
 ``{HTTP header field name}cqh``
     Logs the information in the requested field of the client request
     HTTP header. For example, ``%<{Accept-Language}cqh>`` logs the
-    ``Accept-Language:``\ field in client request headers.
+    ``Accept-Language:`` field in client request headers.
 
 ``{HTTP header field name}pqh``
     Logs the information in the requested field of the proxy request
     HTTP header. For example, ``%<{Authorization}pqh>`` logs
-    the\ ``Authorization:`` field in proxy request headers.
+    the ``Authorization:`` field in proxy request headers.
 
 ``{HTTP header field name}psh``
     Logs the information in the requested field of the proxy response
@@ -107,16 +109,13 @@ The following list describes Traffic Server custom logging fields.
     value (for example, 16:01:19).
 
 ``cqtx``
-    The full HTTP client request text, minus headers; for example,
-
-    ::
+    The full HTTP client request text, minus headers; for example, ::
 
          GET http://www.company.com HTTP/1.0
 
     In reverse proxy mode, Traffic Server logs the rewritten/mapped URL
     (according to the rules in the
-    ```remap.config`` <../configuration-files/remap.config>`_ file),
-    _not_ the pristine/unmapped URL.
+    :file:`remap.config` file), _not_ the pristine/unmapped URL.
 
 ``cqu``
     The universal resource identifier (URI) of the request from client
@@ -124,7 +123,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
-    ```remap.config`` <../configuration-files/remap.config>`_ file),
+    :ref:`remap.config` file),
     _not_ the pristine/unmapped URL.
 
 ``cquc``
@@ -306,6 +305,9 @@ The following list describes Traffic Server custom logging fields.
     the connection with Traffic Server and the time at which Traffic
     Server sends the last byte of the response back to the client.
 
+
+.. _logging-format-cross-reference:
+
 Logging Format Cross-Reference
 ==============================
 
@@ -319,11 +321,20 @@ 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`` ``action/code`` \|
-``crc/pssc`` ``size`` \| ``psql`` ``method`` \| ``cqhm`` ``url`` \|
-``cquc`` ``ident`` \| ``caun`` ``hierarchy/from`` \| ``phr/pqsn``
-``content`` \| ``psct``
+=====              =============
+Squid              Field Symbols
+=====              =============
+``time``           ``cqts``
+``elapsed``        ``ttms``
+``client``         ``chi``
+``action/code``    ``crc/pssc``
+``size``           ``psql``
+``method``         ``cqhm``
+``url``            ``cquc``
+``ident``          ``caun``
+``hierarchy/from`` ``phr/pqsn``
+``content``        ``psct``
+=====              =============
 
 Netscape Common Logging Formats
 -------------------------------
@@ -331,9 +342,16 @@ Netscape Common Logging Formats
 The following is a list of the Netscape Common logging fields and the
 corresponding Traffic Server logging field symbols.
 
-Netscape Common \| Field Symbols ----------------\|--------------
-``host`` \| ``chi`` ``usr`` \| ``caun`` ``[time]`` \| ``[cqtn]``
-``"req"`` \| ``"cqtx"`` ``s1`` \| ``pssc`` ``c1`` \| ``pscl``
+=============== =============
+Netscape Common Field Symbols
+=============== =============
+``host``        ``chi``
+``usr``         ``caun``
+``[time]``      ``[cqtn]``
+``"req"``       ``"cqtx"``
+``s1``          ``pssc``
+``c1``          ``pscl``
+=============== =============
 
 Netscape Extended Logging Formats
 ---------------------------------
@@ -341,12 +359,25 @@ Netscape Extended Logging Formats
 The following table lists the Netscape Extended logging fields and the
 corresponding Traffic Server logging field symbols.
 
-Netscape Extended \| Field Symbols ------------------\|--------------
-``host`` \| ``chi`` ``usr`` \| ``caun`` ``[time]`` \| ``[cqtn]``
-``"req"`` \| ``"cqtx"`` ``s1`` \| ``pssc`` ``c1`` \| ``pscl`` ``s2`` \|
-``sssc`` ``c2`` \| ``sscl`` ``b1`` \| ``cqbl`` ``b2`` \| ``pqbl`` ``h1``
-\| ``cqhl`` ``h2`` \| ``pshl`` ``h3`` \| ``pqhl`` ``h4`` \| ``sshl``
-``xt`` \| ``tts``
+================= =============
+Netscape Extended Field Symbols
+================= =============
+``host``          ``chi``
+``usr``           ``caun``
+``[time]``        ``[cqtn]``
+``"req"``         ``"cqtx"``
+``s1``            ``pssc``
+``c1``            ``pscl``
+``s2``            ``sssc``
+``c2``            ``sscl``
+``b1``            ``cqbl``
+``b2``            ``pqbl``
+``h1``            ``cqhl``
+``h2``            ``pshl``
+``h3``            ``pqhl``
+``h4``            ``sshl``
+``xt``            ``tts``
+================= =============
 
 Netscape Extended-2 Logging Formats
 -----------------------------------
@@ -354,11 +385,27 @@ Netscape Extended-2 Logging Formats
 The following is a list of the Netscape Extended-2 logging fields and
 the corresponding Traffic Server logging field symbols.
 
-Netscape Extended-2 \| Field Symbols
---------------------\|--------------- ``host`` \| ``chi`` ``usr`` \|
-``caun`` ``[time]`` \| ``[cqtn]`` ``"req"`` \| ``"cqtx"`` ``s1`` \|
-``pssc`` ``c1`` \| ``pscl`` ``s2`` \| ``sssc`` ``c2`` \| ``sscl`` ``b1``
-\| ``cqbl`` ``b2`` \| ``pqbl`` ``h1`` \| ``cqhl`` ``h2`` \| ``pshl``
-``h3`` \| ``pqhl`` ``h4`` \| ``sshl`` ``xt`` \| ``tts`` ``route`` \|
-``phr`` ``pfs`` \| ``cfsc`` ``ss`` \| ``pfsc`` ``crc`` \| ``crc``
+=================== =============
+Netscape Extended-2 Field Symbols
+=================== =============
+``host``            ``chi``
+``usr``             ``caun``
+``[time]``          ``[cqtn]``
+``"req"``           ``"cqtx"``
+``s1``              ``pssc``
+``c1``              ``pscl``
+``s2``              ``sssc``
+``c2``              ``sscl``
+``b1``              ``cqbl``
+``b2``              ``pqbl``
+``h1``              ``cqhl``
+``h2``              ``pshl``
+``h3``              ``pqhl``
+``h4``              ``sshl``
+``xt``              ``tts`` 
+``route``           ``phr``
+``pfs``             ``cfsc``
+``ss``              ``pfsc``
+``crc``             ``crc``
+=================== =============
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/0f585e99/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 17ff827..b0e2e5d 100644
--- a/doc/admin/traffic-server-error-messages.en.rst
+++ b/doc/admin/traffic-server-error-messages.en.rst
@@ -1,3 +1,5 @@
+.. _traffic-server-error-messages:
+
 Error Messages
 **************
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/0f585e99/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 2e32038..98f9b31 100644
--- a/doc/admin/working-log-files.en.rst
+++ b/doc/admin/working-log-files.en.rst
@@ -53,11 +53,11 @@ keeps three types of log files:
 
    All system information messages are logged with the system-wide
    logging facility :manpage:`syslog` under the daemon facility. The
-   ``syslog.conf`` configuration file (stored in the ``/etc`` directory)
+   :manpage:`syslog.conf(5)` configuration file (stored in the ``/etc`` directory)
    specifies where these messages are logged. A typical location is
    ``/var/log/messages`` (Linux).
 
-   The ``syslog`` process works on a system-wide basis, so it serves as
+   The :manpage:`syslog(8)` process works on a system-wide basis, so it serves as
    the single repository for messages from all Traffic Server processes
    (including :program:`traffic_server`, :program:`traffic_manager`, and
    :program:`traffic_cop`).
@@ -67,14 +67,13 @@ keeps three types of log files:
    logged, the hostname of the Traffic Server that reported the error,
    and a description of the error or warning.
 
-   Refer to `Traffic Server Error
-   Messages <../traffic-server-error-messages>`_ for a list of the
+   Refer to :ref:`traffic-server-error-messages` for a list of the
    messages logged by Traffic Server.
 
 By default, Traffic Server creates both error and event log files and
 records system information in system log files. You can disable event
 logging and/or error logging by setting the configuration variable
-``_proxy.config.log.logging_enabled_`` (in the :file:`records.config` file)
+:ts:cv:`proxy.config.log.logging_enabled` (in the :file:`records.config` file)
 to one of the following values:
 
 -  ``0`` to disable both event and error logging
@@ -82,8 +81,8 @@ to one of the following values:
 -  ``2`` to enable transaction logging only
 -  ``3`` to enable both transaction and error logging
 
-Understanding Event Log Files # {#UnderstandingEventLogFiles}
-=============================================================
+Understanding Event Log Files
+=============================
 
 Event log files record information about every request that Traffic
 Server processes. By analyzing the log files, you can determine how many
@@ -104,7 +103,7 @@ features and discuss how to:
 
    You can choose a central location for storing log files, set how much
    disk space to use for log files, and set how and when to roll log
-   files. Refer to `Managing Event Log Files <#ManagingEventLogFiles>`_.
+   files. Refer to `Managing Event Log Files`_.
 
 -  **Choose different event log file formats**
 
@@ -112,41 +111,36 @@ features and discuss how to:
    traffic analysis, such as Squid or Netscape. Alternatively, you can
    use the Traffic Server custom format, which is XML-based and enables
    you to institute more control over the type of information recorded
-   in log files. Refer to `Choosing Event Log File
-   Formats <#ChoosingEventLogFileFormats>`_.
+   in log files. Refer to `Choosing Event Log File Formats`_.
 
 -  **Roll event log files automatically**
 
    Configure Traffic Server to roll event log files at specific
    intervals during the day or when they reach a certain size; this
    enables you to identify and manipulate log files that are no longer
-   active. Refer to `Rolling Event Log Files <#RollingEventLogFiles>`_.
+   active. Refer to `Rolling Event Log Files`_.
 
 -  **Separate log files according to protocols and hosts**
 
    Configure Traffic Server to create separate log files for different
    protocols. You can also configure Traffic Server to generate separate
-   log files for requests served by different hosts. Refer to `Splitting
-   Event Log Files <#SplittingEventLogFiles>`_.
+   log files for requests served by different hosts. Refer to `Splitting Event Log Files`_.
 
 -  **Collate log files from different Traffic Server nodes**
 
    Designate one or more nodes on the network to serve as log collation
    servers. These servers, which might be standalone or part of Traffic
    Server, enable you to keep all logged information in well-defined
-   locations. Refer to `Collating Event Log
-   Files <#CollatingEventLogFiles>`_.
+   locations. Refer to `Collating Event Log Files`_.
 
 -  **View statistics about the logging system**
 
    Traffic Server provides statistics about the logging system; you can
-   access these statistics via Traffic Line. Refer to `Viewing Logging
-   Statistics <#ViewingLoggingStatistics>`_.
+   access these statistics via Traffic Line. Refer to `Viewing Logging Statistics`_.
 
 -  **Interpret log file entries for the log file formats**
 
-   Refer to `Example Event Log File
-   Entries <#ExampleEventLogFileEntries>`_.
+   Refer to `Example Event Log File Entries`_.
 
 Managing Event Log Files
 ------------------------
@@ -160,8 +154,7 @@ Choosing the Logging Directory
 
 By default, Traffic Server writes all event log files in the ``logs``
 directory located in the directory where you installed Traffic Server.
-To use a different directory, refer to `Setting Log File Management
-Options <#SettingLogFileManagementOptions>`_.
+To use a different directory, refer to `Setting Log File Management Options`_.
 
 Controlling Logging Space
 -------------------------
@@ -171,12 +164,11 @@ logging directory can consume. This allows the system to operate
 smoothly within a specified space window for a long period of time.
 After you establish a space limit, Traffic Server continues to monitor
 the space in the logging directory. When the free space dwindles to the
-headroom limit (see `Setting Log File Management
-Options <#SettingLogFileManagementOptions>`_), it enters a low space
-state and takes the following actions:
+headroom limit (see `Setting Log File Management Options`_), it enters
+a low space state and takes the following actions:
 
--  If the autodelete option (discussed in `Rolling Event Log
-   Files <#RollingEventLogFiles>`_) is *enabled*, then Traffic Server
+-  If the autodelete option (discussed in `Rolling Event Log Files`_)
+   is *enabled*, then Traffic Server
    identifies previously-rolled log files (i.e., log files with the
    ``.old`` extension). It starts deleting files one by one, beginning
    with the oldest file, until it emerges from the low state. Traffic
@@ -191,24 +183,26 @@ state and takes the following actions:
    available, either explicitly increase the logging space limit or
    remove files from the logging directory manually.
 
-You can run a ``cron`` script in conjunction with Traffic Server to
+You can run a :manpage:`cron(8)` script in conjunction with Traffic Server to
 automatically remove old log files from the logging directory before
 Traffic Server enters the low space state. Relocate the old log files to
 a temporary partition, where you can run a variety of log analysis
 scripts. Following analysis, either compress the logs and move to an
 archive location, or simply delete them.
 
+
+.. XXX would be nice if we provided a logrotate for this kind of junk, although it could turn out hard, given the patterns..
+
 Setting Log File Management Options
 -----------------------------------
 
 To set log management options, follow the steps below:
 
-1. In the `:file:`records.config` <../configuration-files/records.config>`_
-   file, edit the following variables
+1. In the :file:`records.config` file, edit the following variables
 
-   -  `*``proxy.config.log.logfile_dir``* <../configuration-files/records.config#proxy.config.log.logfile_dir>`_
-   -  `*``proxy.config.log.max_space_mb_for_logs``* <../configuration-files/records.config#proxy.config.log.max_space_mb_for_logs>`_
-   -  `*``proxy.config.log.max_space_mb_headroom``* <../configuration-files/records.config#proxy.config.log.max_space_mb_headroom>`_
+   -  :ts:cv:`proxy.config.log.logfile_dir`
+   -  :ts:cv:`proxy.config.log.max_space_mb_for_logs`
+   -  :ts:cv:`proxy.config.log.max_space_mb_headroom`
 
 2. Run the command :option:`traffic_line -x` to apply the configuration
    changes.
@@ -218,14 +212,11 @@ Choosing Event Log File Formats
 
 Traffic Server supports the following log file formats:
 
--  Standard formats, such as Squid or Netscape; refer to `Using Standard
-   Formats <#UsingStandardFormats>`_.
--  The Traffic Server custom format; refer to `Using the Custom
-   Format <#UsingCustomFormat>`_.
+-  Standard formats, such as Squid or Netscape; refer to `Using Standard Formats`_.
+-  The Traffic Server custom format; refer to `Using the Custom Format`_.
 
 In addition to the standard and custom log file format, you can choose
-whether to save log files in binary or ASCII; refer to `Choosing Binary
-or ASCII <#ChoosingBinaryASCII>`_.
+whether to save log files in binary or ASCII; refer to `Choosing Binary or ASCII`_.
 
 Event log files consume substantial disk space. Creating log entries in
 multiple formats at the same time can consume disk resources very
@@ -238,44 +229,44 @@ The standard log formats include Squid, Netscape Common, Netscape
 extended, and Netscape Extended-2. The standard log file formats can be
 analyzed with a wide variety of off-the-shelf log-analysis packages. You
 should use one of the standard event log formats unless you need
-information that these formats do not provide. Refer to `Using the
-Custom Format <#UsingCustomFormat>`_.
+information that these formats do not provide. Refer to `Using the Custom Format`_.
 
 Set standard log file format options by following the steps below:
 
-1. In the `:file:`records.config` <../configuration-files/records.config>`_
-   file, edit the following variables
+1. In the :file:`records.config` file, edit the following variables
 2. Edit the following variables to use the Squid format:
 
-   -  `*``proxy.config.log.squid_log_enabled``* <../configuration-files/records.config#proxy.config.log.squid_log_enabled>`_
-   -  `*``proxy.config.log.squid_log_is_ascii``* <../configuration-files/records.config#proxy.config.log.squid_log_is_ascii>`_
-   -  `*``proxy.config.log.squid_log_name``* <../configuration-files/records.config#proxy.config.log.squid_log_name>`_
-   -  `*``proxy.config.log.squid_log_header``* <../configuration-files/records.config#proxy.config.log.squid_log_header>`_
+   -  :ts:cv:`proxy.config.log.squid_log_enabled`
+   -  :ts:cv:`proxy.config.log.squid_log_is_ascii`
+   -  :ts:cv:`proxy.config.log.squid_log_name`
+   -  :ts:cv:`proxy.config.log.squid_log_header`
 
 3. To use the Netscape Common format, edit the following variables:
 
-   -  `*``proxy.config.log.common_log_enabled``* <../configuration-files/records.config#proxy.config.log.common_log_enabled>`_
-   -  `*``proxy.config.log.common_log_is_ascii``* <../configuration-files/records.config#proxy.config.log.common_log_is_ascii>`_
-   -  `*``proxy.config.log.common_log_name``* <../configuration-files/records.config#proxy.config.log.common_log_name>`_
-   -  `*``proxy.config.log.common_log_header``* <../configuration-files/records.config#proxy.config.log.common_log_header>`_
+   -  :ts:cv:`proxy.config.log.common_log_enabled`
+   -  :ts:cv:`proxy.config.log.common_log_is_ascii`
+   -  :ts:cv:`proxy.config.log.common_log_name`
+   -  :ts:cv:`proxy.config.log.common_log_header`
 
 4. To use the Netscape Extended format, edit the following variables:
 
-   -  `*``proxy.config.log.extended_log_enabled``* <../configuration-files/records.config#proxy.config.log.extended_log_enabled>`_
-   -  `*``proxy.config.log.extended_log_is_ascii``* <../configuration-files/records.config#proxy.config.log.extended_log_is_ascii>`_
-   -  `*``proxy.config.log.extended_log_name``* <../configuration-files/records.config#proxy.config.log.extended_log_name>`_
-   -  `*``proxy.config.log.extended_log_header``* <../configuration-files/records.config#proxy.config.log.extended_log_header>`_
+   -  :ts:cv:`proxy.config.log.extended_log_enabled`
+   -  :ts:cv:`proxy.config.log.extended_log_is_ascii`
+   -  :ts:cv:`proxy.config.log.extended_log_name`
+   -  :ts:cv:`proxy.config.log.extended_log_header`
 
 5. To use the Netscape Extended-2 format, edit the following variables:
 
-   -  `*``proxy.config.log.extended2_log_enabled``* <../configuration-files/records.config#proxy.config.log.extended2_log_enabled>`_
-   -  `*``proxy.config.log.extended2_log_is_ascii``* <../configuration-files/records.config#proxy.config.log.extended2_log_is_ascii>`_
-   -  `*``proxy.config.log.extended2_log_name``* <../configuration-files/records.config#proxy.config.log.extended2_log_name>`_
-   -  `*``proxy.config.log.extended2_log_header``* <../configuration-files/records.config#proxy.config.log.extended2_log_header>`_
+   -  :ts:cv:`proxy.config.log.extended2_log_enabled`
+   -  :ts:cv:`proxy.config.log.extended2_log_is_ascii`
+   -  :ts:cv:`proxy.config.log.extended2_log_name`
+   -  :ts:cv:`proxy.config.log.extended2_log_header`
 
 6. Run the command :option:`traffic_line -x` to apply the configuration
    changes.
 
+.. XXX:: setting what values?
+
 Using the Custom Format
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -287,18 +278,18 @@ decide what information to record for each Traffic Server transaction
 and create filters that specify which transactions to log.
 
 The heart of the XML-based custom logging feature is the XML-based
-logging configuration file (``logs_xml.config``) that enables you to
+logging configuration file (:file:`logs_xml.config`) that enables you to
 create very modular descriptions of logging objects. The
-``logs_xml.config`` file uses three types of objects to create custom
+:file:`logs_xml.config` file uses three types of objects to create custom
 log files, as detailed below. To generate a custom log format, you must
 specify at least one ``LogObject`` definition (one log file is produced
 for each ``LogObject`` definition).
 
--  The **``LogFormat``** object defines the content of the log file
+-  The ``LogFormat`` object defines the content of the log file
    using printf-style format strings.
--  The **``LogFilter``** object defines a filter so that you include or
+-  The ``LogFilter`` object defines a filter so that you include or
    exclude certain information from the log file.
--  The **``LogObject``** object specifies all the information needed to
+-  The ``LogObject`` object specifies all the information needed to
    produce a log file.
 
    -  The name of the log file. (required)
@@ -335,10 +326,10 @@ for each ``LogObject`` definition).
 In order to accomplish this, we
 
 1. edit the following variables in the
-   `:file:`records.config` <../configuration-files/records.config>`_ file:
-2. `*``proxy.config.log.custom_logs_enabled``* <../configuration-files/records.config#proxy.config.log.custom_logs_enabled>`_
+   :file:`records.config` file:
+2. :ts:cv:`proxy.config.log.custom_logs_enabled`
 3. In the
-   ```logs_xml.config`` <../configuration-files/logs_xml.config>`_ file
+   :file:`logs_xml.config` file
 4. Add
    ```LogFormat`` <../configuration-files/logs_xml.config#LogFormat>`_,
    ```LogFilter`` <../configuration-files/logs_xml.config#LogFilters>`_,
@@ -362,7 +353,7 @@ generated.
 To generate a summary log file, create a
 ```LogFormat`` <../configuration-files/logs_xml.config#LogFormat>`_
 object in the XML-based logging configuration file
-(```logs_xml.config`` <../configuration-files/logs_xml.config>`_) using
+(: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.
 
@@ -375,7 +366,7 @@ operators to specific fields, over a specified interval.
 To create a summary log file format, we
 
 1. Define the format of the log file in
-   ```logs_xml.config`` <../configuration-files/logs_xml.config>`_ as
+   :file:`logs_xml.config` as
    follows:
 
    ::
@@ -387,38 +378,33 @@ To create a summary log file format, we
          <Interval = "n"/>  
        </LogFormat>  
 
-   where *``operator``* is one of the five aggregate operators
-   (``COUNT``, ``SUM``, ``AVERAGE``, ``FIRST``, ``LAST``), *``field``*
-   is the logging field you want to aggregate, and *``n``* is the
+   where ``operator`` is one of the five aggregate operators
+   (``COUNT``, ``SUM``, ``AVERAGE``, ``FIRST``, ``LAST``), ``field``
+   is the logging field you want to aggregate, and ``n`` is the
    interval (in seconds) between summary log entries. You can specify
-   more than one *``operator``* in the format line. For more
-   information, refer to
-   ```logs_xml.config`` <../configuration-files/logs_xml.config>`_.
+   more than one ``operator`` in the format line. For more
+   information, refer to :file`logs_xml.config`.
 
 2. Run the command :option:`traffic_line -x` to apply configuration changes .
 
 The following example format generates one entry every 10 seconds. Each
 entry contains the timestamp of the last entry of the interval, a count
 of the number of entries seen within that 10-second interval, and the
-sum of all bytes sent to the client:
-
-::
+sum of all bytes sent to the client: ::
 
-    :::xml
     <LogFormat>
       <Name = "summary"/>
       <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)>"/>
       <Interval = "10"/>
     </LogFormat>
 
-**IMPORTANT:** You cannot create a format specification that contains
-both aggregate operators and regular fields. For example, the following
-specification would be **invalid**:
+.. important::
 
-::
+    You cannot create a format specification that contains
+    both aggregate operators and regular fields. For example, the following
+    specification would be **invalid**: ::
 
-    :::xml
-    <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)> : %<cqu>"/>
+        <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)> : %<cqu>"/>
 
 Choosing Binary or ASCII
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -460,8 +446,7 @@ the number of requests is roughly the same for both days, then you can
 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 <#SettingStandardLogFileFormatOptions>`_). For the custom log
+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
@@ -472,8 +457,7 @@ this option is that Traffic Server does not have to write to disk, which
 frees disk space and bandwidth for other tasks. In addition, writing to
 a pipe does not stop when logging space is exhausted because the pipe
 does not use disk space. Refer to
-```logs_xml.config`` <../configuration-files/logs_xml.config>`_ for more
-information about the ``ASCII_PIPE`` option.
+:file:`logs_xml.config` for more information about the ``ASCII_PIPE`` option.
 
 
 Rolling Event Log Files
@@ -518,9 +502,7 @@ information:
 -  The suffix ``.old``, which makes it easy for automated scripts to
    find rolled log files.
 
-Timestamps have the following format:
-
-::
+Timestamps have the following format: ::
 
     %Y%M%D.%Hh%Mm%Ss-%Y%M%D.%Hh%Mm%Ss
 
@@ -544,9 +526,7 @@ The following table describes the format:
 ``%S``
     The second in two-digit format, from 00-59. For example: 36.
 
-The following is an example of a rolled log filename:
-
-::
+The following is an example of a rolled log filename: ::
 
      squid.log.mymachine.20110912.12h00m00s-20000913.12h00m00s.old
 
@@ -557,17 +537,13 @@ than the time of rolling. When the new log file is rolled, its first
 timestamp will be a lower bound for the timestamp of the first entry.
 
 For example, suppose logs are rolled every three hours, and the first
-rolled log file is:
-
-::
+rolled log file is: ::
 
     squid.log.mymachine.20110912.12h00m00s-19980912.03h00m00s.old
 
 If the lower bound for the first entry in the log buffer at 3:00:00 is
 2:59:47, then the next log file will have the following timestamp when
-rolled:
-
-::
+rolled: ::
 
     squid.log.mymachine.20110912.02h59m47s-19980912.06h00m00s.old
 
@@ -598,13 +574,12 @@ Setting Log File Rolling Options
 To set log file rolling options and/or configure Traffic Server to roll
 log files when they reach a certain size, follow the steps below:
 
-1. In the `:file:`records.config` <../configuration-files/records.config>`_
-   file, edit the following variables
+1. In the :file:`records.config` file, edit the following variables
 
-   -  `*``proxy.config.log.rolling_enabled``* <../configuration-files/records.config#proxy.config.log.rolling_enabled>`_
-   -  `*``proxy.config.log.rolling_size_mb``* <../configuration-files/records.config#proxy.config.log.rolling_size_mb>`_
-   -  `*``proxy.config.log.rolling_offset_hr``* <../configuration-files/records.config#proxy.config.log.rolling_offset_hr>`_
-   -  `*``proxy.config.log.rolling_interval_sec``* <../configuration-files/records.config#proxy.config.log.rolling_interval_sec>`_
+   -  :ts:cv:`proxy.config.log.rolling_enabled`
+   -  :ts:cv:`proxy.config.log.rolling_size_mb`
+   -  :ts:cv:`proxy.config.log.rolling_offset_hr`
+   -  :ts:cv:`proxy.config.log.rolling_interval_sec`
 
 2. Run the command :option:`traffic_line -x` to apply the configuration
    changes.
@@ -612,12 +587,11 @@ log files when they reach a certain size, follow the steps below:
 You can fine-tune log file rolling settings for a custom log file in the
 ```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_
 specification in the
-```logs_xml.config`` <../configuration-files/logs_xml.config>`_ file.
+:file:`logs_xml.config` file.
 The custom log file uses the rolling settings in its
 ```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_,
 which override the default settings you specify in Traffic Manager or
-the `:file:`records.config` <../configuration-files/records.config>`_ file
-described above.
+the :file:`records.config` file described above.
 
 Splitting Event Log Files
 -------------------------
@@ -632,7 +606,7 @@ ICP Log Splitting
 
 When ICP log splitting is enabled, Traffic Server records ICP
 transactions in a separate log file with a name that contains
-**``icp``**. For example: if you enable the Squid format, then all ICP
+``icp``. For example: if you enable the Squid format, then all ICP
 transactions are recorded in the ``squid-icp.log`` file. When you
 disable ICP log splitting, Traffic Server records all ICP transactions
 in the same log file as HTTP transactions.
@@ -677,20 +651,18 @@ from the previous example, Traffic Server generates the log files below:
 ``squid.log``
     All other entries
 
-Traffic Server also enables you to create XML-based `Custom Log
-Formats <#UsingCustomFormat>`_ that offer even greater control over log
-file generation.
+Traffic Server also enables you to create XML-based :ref:`Custom Log Formats <using-custom-log-formats>`
+that offer even greater control over log file generation.
 
 Setting Log Splitting Options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To set log splitting options, follow the steps below:
 
-1. In the `:file:`records.config` <../configuration-files/records.config>`_
-   file, edit the following variables
+1. In the :file:`records.config` file, edit the following variables
 
-   -  `*``proxy.config.log.separate_icp_logs``* <../configuration-files/records.config#proxy.config.log.separate_icp_logs>`_
-   -  `*``proxy.config.log.separate_host_logs``* <../configuration-files/records.config#proxy.config.log.separate_host_logs>`_
+   -  :ts:cv:`proxy.config.log.separate_icp_logs`
+   -  :ts:cv:`proxy.config.log.separate_host_logs`
 
 2. Run the command :option:`traffic_line -x` to apply the configuration
    changes.
@@ -698,29 +670,27 @@ To set log splitting options, follow the steps below:
 Editing the log_hosts.config File
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The default ``log_hosts.config`` file is located in the Traffic Server
+The default :file:`log_hosts.config` file is located in the Traffic Server
 ``config`` directory. To record HTTP transactions for different origin
 servers in separate log files, you must specify the hostname of each
-origin server on a separate line in the ``log_hosts.config`` file. For
+origin server on a separate line in the :file:`log_hosts.config` file. For
 example, if you specify the keyword sports, then Traffic Server records
 all HTTP transactions from ``sports.yahoo.com`` and
 ``www.foxsports.com`` in a log file called ``squid-sports.log`` (if the
 Squid format is enabled).
 
-**Note:** If Traffic Server is clustered and you enable log file
-collation, then you should use the same ``log_hosts.config`` file on
-every Traffic Server node in the cluster.
+.. note::
 
-To edit the ``log_hosts.config`` file follow the steps below:
+    If Traffic Server is clustered and you enable log file
+    collation, then you should use the same :file:`log_hosts.config` file on
+    every Traffic Server node in the cluster.
 
-1. In the
-   ```log_hosts.config`` <../configuration-files/records.config>`_ file,
-   enter the hostname of each origin server on a separate line in the
-   file, e.g.:
+To edit the :file:`log_hosts.config` file follow the steps below:
 
-   ::
+1. In the :file:`log_hosts.config` file, 
+   enter the hostname of each origin server on a separate line in the
+   file, e.g.: ::
 
-       :::text
        webserver1
        webserver2
        webserver3
@@ -760,12 +730,14 @@ If log clients cannot contact their log collation server, then they
 write their log buffers to their local disks, into *orphan* log files.
 Orphan log files require manual collation.
 
-**Note:** Log collation can have an impact on network performance.
-Because all nodes are forwarding their log data buffers to the single
-collation server, a bottleneck can occur. In addition, collated log
-files contain timestamp information for each entry, but entries in the
-files do not appear in strict chronological order. You may want to sort
-collated log files before doing analysis.
+.. note::
+
+    Log collation can have an impact on network performance.
+    Because all nodes are forwarding their log data buffers to the single
+    collation server, a bottleneck can occur. In addition, collated log
+    files contain timestamp information for each entry, but entries in the
+    files do not appear in strict chronological order. You may want to sort
+    collated log files before doing analysis.
 
 To configure Traffic Server to collate event log files, you must perform
 the following tasks:
@@ -778,7 +750,7 @@ the following tasks:
 -  Add an attribute to the
    ```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_
    specification in the
-   ```logs_xml.config`` <../configuration-files/logs_xml.config>`_ file
+   :file:`logs_xml.config` file
    if you are using custom log file formats; refer to `Collating Custom
    Event Log Files <#CollatingCustomEventLogFiles>`_.
 
@@ -788,20 +760,20 @@ Configuring Traffic Server to Be a Collation Server
 To configure a Traffic Server node to be a collation server, simply edit
 a configuration file via the steps below.
 
-1. In the `:file:`records.config` <../configuration-files/records.config>`_
-   file, edit the following variables
+1. In the :file:`records.config`  file, edit the following variables
 
-   -  `*``proxy.config.log.collation_mode``* <../configuration-files/records.config#proxy.config.log.collation_mode>`_
-      (``1`` for server mode)
-   -  `*``proxy.config.log.collation_port``* <../configuration-files/records.config#proxy.config.log.collation_port>`_
-   -  `*``proxy.config.log.collation_secret``* <../configuration-files/records.config#proxy.config.log.collation_secret>`_
+   -  :ts:cv:`proxy.config.log.collation_mode` (``1`` for server mode)
+   -  :ts:cv:`proxy.config.log.collation_port`
+   -  :ts:cv:`proxy.config.log.collation_secret`
 
 2. Run the command :option:`traffic_line -x` to apply the configuration
    changes.
 
-**Note:** If you modify the ``collation_port`` or ``secret`` after
-connections between the collation server and collation clients have been
-established, then you must restart Traffic Server.
+.. note::
+
+    If you modify the ``collation_port`` or ``secret`` after
+    connections between the collation server and collation clients have been
+    established, then you must restart Traffic Server.
 
 Using a Standalone Collator
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -822,7 +794,7 @@ To install and configure a standalone collator:
    directory to the machine serving as the standalone collator.
 4. Create a directory called ``config`` in the directory that contains
    the :program:`traffic_sac` binary.
-5. Create a directory called *``internal``* in the ``config`` directory
+5. Create a directory called ``internal`` in the ``config`` directory
    you created in Step 4 (above). This directory is used internally by
    the standalone collator to store lock files.
 6. Copy the :file:`records.config` file from a Traffic Server node
@@ -832,10 +804,10 @@ To install and configure a standalone collator:
    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.
-7. In the `:file:`records.config` <../configuration-files/records.config>`_
+7. In the :file:`records.config`
    file, edit the following variable
 
-   -  `*``proxy.config.log.logfile_dir``* <../configuration-files/records.config#proxy.config.log.logfile_dir>`_
+   -  :ts:cv:`proxy.config.log.logfile_dir`
 
 8. Enter the following command::
 
@@ -849,20 +821,17 @@ steps below. If you modify the ``collation_port`` or ``secret`` after
 connections between the collation clients and the collation server have
 been established, then you must restart Traffic Server.
 
-1. In the `:file:`records.config` <../configuration-files/records.config>`_
-   file, edit the following variables:
+1. In the :file:`records.config` file, edit the following variables:
 
-   -  `*``proxy.config.log.collation_mode``* <../configuration-files/records.config#proxy.config.log.collation_mode>`_:
-      ``2`` to configure this node as log collation client and send
+   -  :ts:cv:`proxy.config.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
-      ```logs_xml.config`` <../configuration-files/logs_xml.config>`_
+       For XML-based formatted log entries, see :file:`logs_xml.config`
       file; refer to `Using the Custom Format <#UsingCustomFormat>`_.
-   -  `*``proxy.config.log.collation_host``* <../configuration-files/records.config#proxy.config.log.collation_host>`_
-   -  `*``proxy.config.log.collation_port``* <../configuration-files/records.config#proxy.config.log.collation_port>`_
-   -  `*``proxy.config.log.collation_secret``* <../configuration-files/records.config#proxy.config.log.collation_secret>`_
-   -  `*``proxy.config.log.collation_host_tagged``* <../configuration-files/records.config#proxy.config.log.collation_host_tagged>`_
-   -  `*``proxy.config.log.max_space_for_orphan_logs``* <../configuration-files/records.config#proxy.config.log.max_space_for_orphan_logs>`_
+   -  :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`
 
 2. Run the command :option:`traffic_line -x` to apply the configuration
    changes.
@@ -871,13 +840,12 @@ Collating Custom Event Log Files
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you use custom event log files, then you must edit the
-``logs_xml.config`` file (in addition to configuring a collation server
+:file:`logs_xml.config` file (in addition to configuring a collation server
 and collation clients).
 
 To collate custom event log files
 
-1. On each collation client, edit the
-   ```logs_xml.config`` <../configuration-files/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
@@ -892,9 +860,9 @@ To collate custom event log files
          <CollationHosts="ipaddress:port"/>
        </LogObject>
 
-   where *``ipaddress``* is the hostname or IP address of the collation
+   where ``ipaddress`` is the hostname or IP address of the collation
    server to which all log entries (for this object) are forwarded, and
-   *``port``* is the port number for communication between the collation
+   ``port`` is the port number for communication between the collation
    server and collation clients.
 
 3. Run the command :option:`traffic_line -L` to restart Traffic Server on the

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/0f585e99/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 9c3ee21..d3aad99 100644
--- a/doc/admin/working-log-files/log-formats.en.rst
+++ b/doc/admin/working-log-files/log-formats.en.rst
@@ -1,3 +1,5 @@
+.. _working-log-files-log-formats:
+
 Log Formats
 ***********
 
@@ -42,7 +44,7 @@ Squid Format
     ``crc/pssc``
     The cache result code; how the cache responded to the request:
     ``HIT``, ``MISS``, and so on. Cache result codes are described
-    `here <#squid-netscape-result-codes>`_.
+    :ref:`here <squid-netscape-result-codes>`.
      The proxy response status code (the HTTP response status code from
     Traffic Server to client).
 
@@ -103,7 +105,8 @@ Squid log in XML
 Netscape Formats
 ================
 
-**Netscape Common**
+Netscape Common
+---------------
 
 ``1``
     ``chi``
@@ -134,7 +137,8 @@ Netscape Formats
     ``pscl``
     The length of the Traffic Server response to the client in bytes.
 
-**Netscape Extended**
+Netscape Extended
+-----------------
 
 ``8``
     ``sssc``
@@ -182,7 +186,8 @@ Netscape Formats
     connection with Traffic Server and the time that Traffic Server sent
     the last byte of the response back to the client.
 
-**Netscape Extended2**
+Netscape Extended2
+------------------
 
 ``17``
     ``phr``
@@ -205,7 +210,7 @@ Netscape Formats
     ``crc``
     The cache result code; how the Traffic Server cache responded to the
     request: HIT, MISS, and so on. Cache result codes are described
-    `here <#squid-netscape-result-codes>`_.
+    :ref:`here <squid-netscape-result-codes>`.
 
 Netscape Common
 ---------------
@@ -275,6 +280,8 @@ Netscape Extended in XML
                  %<sssc> %<sscl> %<cqbl> %<pqbl> %<cqhl> %<pshl> %<pqhl> %<sshl> %<tts> %<phr> %<cfsc> %<pfsc> %<crc>"/>
     </LogFormat>
 
+.. _squid-netscape-result-codes:
+
 Squid- and Netscape-format: Cache Result Codes
 ==============================================
 
@@ -291,19 +298,19 @@ Netscape log files.
     the client.
 
 ``TCP_REFRESH_HIT``
-    The object was in the cache, but it was stale. Traffic Server made
-    an \* ``if-modified-since`` request to the origin server and the
-    origin server sent a \* ``304`` not-modified response. Traffic
+    The object was in the cache, but it was stale. Traffic Server made an 
+    ``if-modified-since`` request to the origin server and the
+    origin server sent a ``304`` not-modified response. Traffic
     Server sent the cached object to the client.
 
 ``TCP_REF_FAIL_HIT``
-    The object was in the cache but was stale. Traffic Server made an \*
+    The object was in the cache but was stale. Traffic Server made an
     ``if-modified-since`` request to the origin server but the server
     did not respond. Traffic Server sent the cached object to the
     client.
 
 ``TCP_REFRESH_MISS``
-    The object was in the cache but was stale. Traffic Server made an \*
+    The object was in the cache but was stale. Traffic Server made an
     ``if-modified-since`` request to the origin server and the server
     returned a new object. Traffic Server served the new object to the
     client.
@@ -315,8 +322,8 @@ Netscape log files.
     the object from cache.
 
 ``TCP_IMS_HIT``
-    The client issued an \* ``if-modified-since`` request and the object
-    was in cache & fresher than the IMS date, **or** an \*
+    The client issued an ``if-modified-since`` request and the object
+    was in cache & fresher than the IMS date, **or** an
     ``if-modified-since`` request to the origin server revealed the
     cached object was fresh. Traffic Server served the cached object to
     the client.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/0f585e99/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 54fd14f..f1796b9 100644
--- a/doc/reference/configuration/logs_xml.config.en.rst
+++ b/doc/reference/configuration/logs_xml.config.en.rst
@@ -41,47 +41,50 @@ The :file:`logs_xml.config` file contains the specifications below:
 The :file:`logs_xml.config` file ignores extra white space, blank lines, and
 all comments.
 
+.. _LogFormat:
+
 LogFormat
 =========
 
 The following list shows ``LogFormat`` specifications.
 
-*``&lt;Name = "valid_format_name"/&gt;``* {#LogsXMLFormatName}
+.. _LogFormat-name:
+
+``<Name = "valid_format_name"/>``
     Required
     Valid format names include any name except ``squid``, ``common``,
     ``extended``, or ``extended2``, which are pre-defined formats. There
     is no default for this tag.
 
-*``&lt;Format = "valid_format_specification"/&gt;``* {#LogsXMLFormat}
+.. _LogFormat-Format:
+
+``<Format = "valid_format_specification"/>``
     Required
     A valid format specification is a printf-style string describing
     each log entry when formatted for ASCII output. Use ``%<``
-    *``field``* ``>`` as a placeholder for valid field names. For more
-    information, refer to `Custom Logging
-    Fields <../event-logging-formats#CustomLoggingFields>`_.
+    ``field`` ``>`` as a placeholder for valid field names. For more
+    information, refer to :ref:`custom-logging-fields`.
 
     The specified field can be one of the following types:
 
     Simple. For example: ``%<cqu>``
     A field within a container, such as an HTTP header or a statistic.
-    Fields of this type have the syntax:
-
-    ::
+    Fields of this type have the syntax: ::
 
          %<{ field } container>
 
     Aggregates, such as ``COUNT``, ``SUM``, ``AVG``, ``FIRST``,
     ``LAST``. Fields of this type have the syntax: ``%<operator (``
-    *``field``* ``)>``
+    ``field`` ``)>``
 
 .. note::
 
     You cannot create a format specification that contains both aggregate operators and regular fields.
 
-*``&lt;Interval = "aggregate_interval_secs"/&gt;``* {#LogsXMLInterval}
+``<Interval = "aggregate_interval_secs"/>``
     Optional
     Use this tag when the format contains aggregate operators. The value
-    "``aggregate_interval_secs``\ " represents the number of seconds
+    "``aggregate_interval_secs``\" represents the number of seconds
     between individual aggregate values being produced.
 
     The valid set of aggregate operators are:
@@ -92,23 +95,23 @@ The following list shows ``LogFormat`` specifications.
     -  FIRST
     -  LAST
 
+.. _LogFilters:
+
 LogFilters
 ==========
 
 The following list shows the ``LogFilter`` specifications.
 
-*``&lt;Name = "valid_filter_name"/&gt;``* {#LogsXMLFilterName}
+``<Name = "valid_filter_name"/>``
     Required
     All filters must be uniquely named.
 
-*``&lt;Condition = "valid_log_field valid_operator valid_comparison_value"/&gt;``*
-{#LogsXMLFilterCondition}
+``<Condition = "valid_log_field valid_operator valid_comparison_value"/>``
     Required
     This field contains the following elements:
 
     ``valid_log_field`` - the field that will be compared against
-    the given value. For more information, refer to `Logging Format
-    Cross-Reference <../event-logging-formats#LoggingFormatCrossReference>`_.
+    the given value. For more information, refer to :ref:`logging-format-cross-reference`.
 
     ``valid_operator_field`` - any one of the following: ``MATCH``,
     ``CASE_INSENSITIVE_MATCH``, ``CONTAIN``,
@@ -133,24 +136,26 @@ The following list shows the ``LogFilter`` specifications.
     specify a negative condition, then use the ``Action`` field to
     ``REJECT`` the record.
 
-*``&lt;Action = "valid_action_field"/&gt;``* {#LogsXMLFilterAction}
+``<Action = "valid_action_field"/>``
     Required: ``ACCEPT`` or ``REJECT`` .
     This instructs Traffic Server to either accept or reject records
     that satisfy the filter condition.
 
+.. _LogObject:
+
 LogObject
 =========
 
 The following list shows the ``LogObject`` specifications.
 
-*``&lt;Format = "valid_format_name"/&gt;``* {#LogsXMLObjectFormat}
+``<Format = "valid_format_name"/>``
     Required
     Valid format names include the predefined logging formats:
     ``squid``, ``common``, ``extended``, and ``extended2``, as well as
     any previously-defined custom log formats. There is no default for
     this tag.
 
-*``&lt;Filename = "file_name"/&gt;``* {#LogsXMLObjectFilename}
+``<Filename = "file_name"/>``
     Required
     The filename to which the given log file is written on the local
     file system or on a remote collation server. No local log file will
@@ -159,13 +164,15 @@ The following list shows the ``LogObject`` specifications.
 
     If the name does not contain an extension (for example, ``squid``),
     then the extension ``.log`` is automatically appended to it for
-    ASCII logs and ``.blog`` for binary logs (refer to `Mode =
-    "valid_logging_mode" <#LogsXMLOjbectMode>`_).
+    ASCII logs and ``.blog`` for binary logs (refer to :ref:`Mode =
+    "valid_logging_mode" <LogObject-Mode>`_).
 
     If you do not want an extension to be added, then end the filename
     with a single (.) dot (for example: ``squid.`` ).
 
-*``&lt;Mode = "valid_logging_mode"/&gt;``* {#LogsXMLOjbectMode}
+.. _LogObject-Mode:
+
+``<Mode = "valid_logging_mode"/>``
     Optional
     Valid logging modes include ``ascii`` , ``binary`` , and
     ``ascii_pipe`` . The default is ``ascii`` .
@@ -175,7 +182,7 @@ The following list shows the ``LogObject`` specifications.
     -  Use ``binary`` to create event log files in binary format. Binary
        log files generate lower system overhead and occupy less space on
        the disk (depending on the information being logged). You must
-       use the ``logcat`` utility to translate binary log files to ASCII
+       use the :program:`traffic_logcat` utility to translate binary log files to ASCII
        format before you can read them.
     -  Use ``ascii_pipe`` to write log entries to a UNIX named pipe (a
        buffer in memory). Other processes can then read the data using
@@ -191,47 +198,42 @@ The following list shows the ``LogObject`` specifications.
     Traffic Server starts. Pipes on a collation server, however, *are*
     created when Traffic Server starts.
 
-*``&lt;Filters = "list_of_valid_filter_names"/&gt;``*
-{#LogsXMLObjectFilters}
+``<Filters = "list_of_valid_filter_names"/>``
     Optional
     A comma-separated list of names of any previously-defined log
     filters. If more than one filter is specified, then all filters must
     accept a record for the record to be logged.
 
-*``&lt;Protocols = "list_of_valid_protocols"/&gt;``*
-{#LogsXMLObjectProtocols}
+``<Protocols = "list_of_valid_protocols"/>``
     Optional
     A comma-separated list of the protocols this object should log.
     Valid protocol names for this release are ``HTTP`` (FTP is
     deprecated).
 
-*``&lt;ServerHosts = "list_of_valid_servers"/&gt;``*
-{#LogsXMLObjectServerHosts}
+``<ServerHosts = "list_of_valid_servers"/>``
     Optional
     A comma-separated list of valid hostnames.This tag indicates that
     only entries from the named servers will be included in the file.
 
-*``&lt;CollationHosts = "list_of_valid_hostnames"/&gt;``*
-{#LogsXMLObjectCollationHosts}
+``<CollationHosts = "list_of_valid_hostnames"/>``
     Optional
     A comma-separated list of collation servers to which all log entries
     (for this object) are forwarded. Collation servers can be specified
     by name or IP address. Specify the collation port with a colon after
     the name; for example, ``host:port`` .
 
-*``&lt;Header = "header"/&gt;``* {#LogsXMLObjectHeader}
+``<Header = "header"/>``
     Optional
     The header text you want the log files to contain. The header text
     appears at the beginning of the log file, just before the first
     record.
 
-*``&lt;RollingEnabled = "truth value"/&gt;``*
-{#LogsXMLObjectRollingEnabled}
+``<RollingEnabled = "truth value"/>``
     Optional
     Enables or disables log file rolling for the ``LogObject``. This
     setting overrides the value for the
-    *``proxy.config.log.rolling_enabled``* variable in the
-    :file:`records.config` file. Set *``truth value``* to one of the
+    :ts:cv:`proxy.config.log.rolling_enabled` variable in the
+    :file:`records.config` file. Set *truth value* to one of the
     following values:
 
     -  ``0`` to disable rolling for this particular ``LogObject``.
@@ -239,36 +241,36 @@ The following list shows the ``LogObject`` specifications.
        specify time intervals with the ``RollingIntervalSec`` and
        ``RollingOffsetHr`` fields).
     -  ``2`` to roll log files when they reach a certain size (you
-       specify the size with the\ ``RollingSizeMb`` field).
+       specify the size with the ``RollingSizeMb`` field).
     -  ``3`` to roll log files at specific intervals during the day or
        when they reach a certain size (whichever occurs first).
     -  ``4`` to roll log files at specific intervals during the day when
        log files reach a specific size (at a specified time if the file
        is of the specified size).
 
-*``&lt;RollingIntervalSec = "seconds"/&gt;``*
-{#LogsXMLObjectRollingIntervalSec}
+.. XXX this is confusing ^ really, why is it a "truth value" but then it's 5 different integer values that means varias strange things?
+
+``<RollingIntervalSec = "seconds"/>``
     Optional
     The seconds between log file rolling for the ``LogObject``; enables
     you to specify different rolling intervals for different
     ``LogObjects``.
 
     This setting overrides the value for
-    *``proxy.config.log.rolling_interval_sec``* in the
+    :ts:cv:`proxy.config.log.rolling_interval_sec` in the
     :file:`records.config` file.
 
-*``&lt;RollingOffsetHr = "hour"/&gt;``* {#LogsXMLObjectRollingOffsetHr}
+``<RollingOffsetHr = "hour"/>``
     Optional
     Specifies an hour (from 0 to 23) at which rolling is guaranteed to
     align. Rolling might start before then, but a rolled file will be
     produced only at that time. The impact of this setting is only
     noticeable if the rolling interval is larger than one hour. This
     setting overrides the configuration setting for
-    *``proxy.config.log.rolling_offset_hr``* in the :file:`records.config`
+    :ts:cv:`proxy.config.log.rolling_offset_hr` in the :file:`records.config`
     file.
 
-*``&lt;RollingSizeMb = "size_in_MB"/&gt;``*
-{#LogsXMLObjectRollingSizeMb}
+``<RollingSizeMb = "size_in_MB"/>``
     Optional
     The size at which log files are rolled.
 
@@ -304,7 +306,7 @@ The following is an example of a ``LogFilter`` that will cause only
 .. note::
 
     When specifying the field in the filter condition, you can
-    omit the\ ``%<>``. This means that the filter below is equivalent to the
+    omit the ``%<>``. This means that the filter below is equivalent to the
     example directly above: ::
 
          <LogFilter>
@@ -327,9 +329,7 @@ The following is an example of a ``LogObject`` specification that
 includes only HTTP requests served by hosts in the domain
 ``company.com`` or by the specific server ``server.somewhere.com``. Log
 entries are sent to port 4000 of the collation host ``logs.company.com``
-and to port 5000 of the collation host ``209.131.52.129.``
-
-::
+and to port 5000 of the collation host ``209.131.52.129.`` ::
 
          <LogObject>
               <Format = "minimal"/>
@@ -339,6 +339,8 @@ and to port 5000 of the collation host ``209.131.52.129.``
               <CollationHosts = "logs.company.com:4000,209.131.52.129:5000"/>
          </LogObject>
 
+.. _WELF:
+
 WELF
 ====
 
@@ -346,9 +348,7 @@ Traffic Server supports WELF (WebTrends Enhanced Log Format) so you can
 analyze Traffic Server log files with WebTrends reporting tools. A
 predefined ``<LogFormat>`` that is compatible with WELF is provided in
 the :file:`logs_xml.config` file (shown below). To create a WELF format log
-file, create a ``<LogObject>`` that uses this predefined format.
-
-::
+file, create a ``<LogObject>`` that uses this predefined format. ::
 
          <LogFormat>
              <Name = "welf"/>


Mime
View raw message