trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject [38/51] trafficserver git commit: Documentation reorganization
Date Tue, 03 Nov 2015 06:10:14 GMT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/logging/managing-logs.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/logging/managing-logs.en.rst b/doc/admin-guide/monitoring/logging/managing-logs.en.rst
new file mode 100644
index 0000000..5e56501
--- /dev/null
+++ b/doc/admin-guide/monitoring/logging/managing-logs.en.rst
@@ -0,0 +1,330 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../common.defs
+
+.. _admin-monitoring-logging-managing:
+
+Managing Logs
+*************
+
+|TS| enables you to control where event log files are located and how much
+space they can consume. Additionally, you can specify how to handle low disk
+space in the logging directory.
+
+Choosing the Logging Directory
+==============================
+
+By default, Traffic Server writes all event log files in the ``logs``
+directory located in the directory where you installed |TS|. To change this
+location, adjust the value of :ts:cv:`proxy.config.log.logfile_dir` in
+:file:`records.config`. You will need to either restart |TS| or run the
+command :option:`traffic_line -x` for changes to take effect.
+
+Controlling Logging Space
+=========================
+
+|TS| enables you to control the amount of disk space that the 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,
+|TS| continues to monitor the space in the logging directory. When the free
+space dwindles to the headroom limit, it enters a low space state and takes the
+following actions:
+
+-  If the autodelete option (discussed in `Rolling Event Log Files`_)
+   is *enabled*, then |TS| identifies previously-rolled log files (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. |TS| logs a
+   record of all deleted files in the system error log.
+
+-  If the autodelete option is *disabled* or there are not enough old log files
+   to delete for the system to emerge from its low space state, then |TS|
+   issues a warning and continues logging until space is exhausted. When
+   available space is consumed, event logging stops. |TS| resumes event logging
+   when enough space becomes available for it to exit the low space state. To
+   make space available, either explicitly increase the logging space limit or
+   remove files from the logging directory manually.
+
+You can run a :manpage:`cron(8)` script in conjunction with |TS| to
+automatically remove old log files from the logging directory before |TS|
+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.
+
+Setting Log File Management Options
+-----------------------------------
+
+To set log management options, follow the steps below:
+
+#. In the :file:`records.config` file, edit the following variables
+
+   -  :ts:cv:`proxy.config.log.max_space_mb_for_logs`
+   -  :ts:cv:`proxy.config.log.max_space_mb_headroom`
+
+#. Run the command :option:`traffic_line -x` to apply the configuration
+   changes.
+
+Rolling Logs
+============
+
+|TS| provides automatic log file rolling. At specific intervals during the day
+or when log files reach a certain size, |TS| closes its current set of log
+files and opens new log files. Depending on the amount of traffic your servers
+are exposed to, you may find that increasing the frequency of log rolling is
+beneficial, or even necessary, to maintain manageable log file sets. |TS| nodes
+processing moderately high levels of traffic may want to start by rolling logs
+every six hours, and adjusting from there.
+
+Log file rolling offers the following benefits:
+
+-  It defines an consistent interval over which log analysis can be performed.
+
+-  It keeps any single log file from becoming too large and helps to
+   keep the logging system within the specified space limits.
+
+-  It provides an easy way to identify files that are no longer being
+   used so that an automated script can clean the logging directory and
+   run log analysis programs.
+
+Rolled Log Filename Format
+--------------------------
+
+|TS| provides a consistent naming scheme for rolled log files that enables you
+to easily identify log files. When |TS| rolls a log file, it saves and closes
+the old file before it starts a new file. |TS| renames the old file to include
+the following information:
+
+-  The format of the file (such as ``squid.log``).
+
+-  The hostname of the |TS| that generated the log file.
+
+-  Two timestamps separated by a hyphen (``-``). The first timestamp is
+   a *lower bound* for the timestamp of the first record in the log
+   file. The lower bound is the time when the new buffer for log records
+   is created. Under low load, the first timestamp in the filename can
+   be different from the timestamp of the first entry. Under normal
+   load, the first timestamp in the filename and the timestamp of the
+   first entry are similar. The second timestamp is an *upper bound*
+   for the timestamp of the last record in the log file (this is
+   normally the rolling time).
+
+-  The suffix ``.old``, which makes it easy for automated scripts to
+   find rolled log files.
+
+Timestamps have the following format: ::
+
+    %Y%M%D.%Hh%Mm%Ss-%Y%M%D.%Hh%Mm%Ss
+
+The following table describes the format:
+
+====== ============================================ ======
+Format Description                                  Sample
+====== ============================================ ======
+``%Y`` The year in four-digit format.               2000
+``%M`` The month in two-digit format, from 01-12.   07
+``%D`` The day in two-digit format, from 01-31.     19
+``%H`` The hour in two-digit format, from 00-23.    21
+``%M`` The minute in two-digit format, from 00-59.  52
+``%S`` The second in two-digit format, from 00-59.  36
+====== ============================================ ======
+
+.. XXX can %S ever be 60, on account of leap seconds, or does ATS have leap-second related issues that otherwise interfere?
+
+The following is an example of a rolled log filename: ::
+
+     squid.log.mymachine.20110912.12h00m00s-20000913.12h00m00s.old
+
+The logging system buffers log records before writing them to disk. When
+a log file is rolled, the log buffer might be partially full. If it is,
+then the first entry in the new log file will have a timestamp earlier
+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: ::
+
+    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: ::
+
+    squid.log.mymachine.20110912.02h59m47s-19980912.06h00m00s.old
+
+The contents of a log file are always between the two timestamps. Log
+files do not contain overlapping entries, even if successive timestamps
+appear to overlap.
+
+Rolling Intervals
+-----------------
+
+Log files are rolled at specific intervals relative to a given hour of the day.
+Three options may be used to control when log files are rolled:
+
+-  A file size threshold, which will prevent any individual log from growing
+   too large.
+
+-  The offset hour, which is an hour between ``0`` (midnight) and ``23``.
+
+-  The rolling interval.
+
+Both the offset hour and the rolling interval determine when log file rolling
+starts. Rolling occurs every *rolling interval* and at the *offset* hour. For
+example, if the rolling interval is six hours and the offset hour is ``0``
+(midnight), then the logs will roll at midnight (00:00), 06:00, 12:00, and
+18:00 each day. If the rolling interval is 12 hours and the offset hour is
+``3``, then logs will roll at 03:00 and 15:00 each day.
+
+To set log file rolling options and/or configure |TS| to roll log files when
+they reach a certain size, adjust the following settings in
+:file:`records.config`:
+
+#. Enable log rolling with :ts:cv:`proxy.config.log.rolling_enabled`. ::
+
+    CONFIG proxy.config.log.rolling_enabled INT 1
+
+#. Configure the upper limit on log file size with
+   :ts:cv:`proxy.config.log.rolling_size_mb`. ::
+
+    CONFIG proxy.config.log.rolling_size_mb INT 1024
+
+#. Set the offset hour with :ts:cv:`proxy.config.log.rolling_offset_hr`. ::
+
+    CONFIG proxy.config.log.rolling_offset_hr INT 0
+
+#. Set the interval (in seconds) with
+   :ts:cv:`proxy.config.log.rolling_interval_sec`. ::
+
+    CONFIG proxy.config.log.rolling_interval_sec INT 21600
+
+#. Run the command :option:`traffic_line -x` to apply the configuration
+   changes.
+
+You can fine-tune log file rolling settings for a custom log file in the
+:ref:`LogObject` specification in :file:`logs_xml.config`. The custom log file
+uses the rolling settings in its :ref:`LogObject`, which override the default
+settings you specify in Traffic Manager or :file:`records.config` described
+above.
+
+.. _admin-monitoring-logging-host-split:
+
+Separating Logs by Origin
+=========================
+
+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,
+|TS| creates a separate log file for each origin server that's listed in
+:file:`log_hosts.config`.
+
+To enable host log splitting, perform the following steps:
+
+-  Adjust the setting :ts:cv:`proxy.config.log.separate_host_logs` in
+   :file:`records.config`::
+
+    CONFIG proxy.config.log.separate_host_logs INT 1
+
+-  Run the command :option:`traffic_line -x` to apply the changes, or restart
+   |TS|.
+
+When both ICP (covered in :ref:`admin-monitoring-logging-icp-split`) and HTTP
+host log splitting are enabled, |TS| 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 :file:`log_hosts.config`
+contains the two origin servers ``uni.edu`` and ``company.com`` and Squid
+format is enabled, then |TS| generates the following log files:
+
+=========================== ============================================
+Log File                    Contents
+=========================== ============================================
+``squid-uni.edu.log``       All HTTP transactions for ``uni.edu``.
+``squid-company.com.log``   All HTTP transactions for ``company.com``.
+``squid-icp.log``           All ICP transactions for all hosts.
+``squid.log``               All HTTP transactions for other hosts.
+=========================== ============================================
+
+If you disable ICP log splitting, then ICP transactions are placed in the same
+log file as HTTP transactions. Using the hosts and log format from the previous
+example, |TS| generates the log files below:
+
+=========================== ============================================
+Log File                    Contents
+=========================== ============================================
+``squid-uni.edu.log``       All entries for ``uni.edu``.
+``squid-company.com.log``   All entries for ``company.com``.
+``squid.log``               All other entries.
+=========================== ============================================
+
+|TS| also enables you to create XML-based
+:ref:`admin-monitoring-logging-custom-formats` that offer even greater control
+over log file generation.
+
+Defining Hosts in log_hosts.config
+----------------------------------
+
+The default :file:`log_hosts.config` file is located in the |TS| ``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 :file:`log_hosts.config`. 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).
+
+.. important::
+
+   If Traffic Server is clustered and you enable log file collation, then you
+   should use the same :file:`log_hosts.config` file on every |TS| node in the
+   cluster.
+
+To edit the log hosts list:
+
+#. Enter the hostname of each origin server on a separate line in
+   :file:`log_hosts.config`. ::
+
+       webserver1
+       webserver2
+       webserver3
+
+#. Run the command :option:`traffic_line -x` to apply the configuration
+   changes.
+
+.. _admin-monitoring-logging-icp-split:
+
+ICP Log Splitting
+=================
+
+By default, |TS| uses standard log formats and generates log
+files that contain HTTP and ICP transactions in the same file. However,
+you can enable log splitting if you prefer to log transactions for
+different protocols in separate log files.
+
+When ICP log splitting is enabled, |TS| 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 transactions are recorded in the
+``squid-icp.log`` file. When you disable ICP log splitting, |TS|
+records all ICP transactions in the same log file as HTTP transactions.
+
+To enable ICP log splitting, perform the following steps:
+
+-  Adjust the setting :ts:cv:`proxy.config.log.separate_icp_logs` in
+   :file:`records.config`::
+
+    CONFIG proxy.config.log.separate_icp_logs INT 1
+
+-  Run the command :option:`traffic_line -x` to apply the changes, or restart
+   |TS|.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/logging/pipes.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/logging/pipes.en.rst b/doc/admin-guide/monitoring/logging/pipes.en.rst
new file mode 100644
index 0000000..d6f99c7
--- /dev/null
+++ b/doc/admin-guide/monitoring/logging/pipes.en.rst
@@ -0,0 +1,35 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../common.defs
+
+.. _admin-monitoring-logging-pipes:
+
+ASCII Log Pipes
+***************
+
+In addition to ``ASCII`` and ``BINARY`` file modes for custom log formats, |TS|
+can output log entries in ``ASCII_PIPE`` mode. This mode writes the log entries
+to a UNIX named pipe (a buffer in memory). Other processes may read from this
+named pipe using standard I/O functions.
+
+The advantage of this mode is that |TS| does not need to write the entries to
+disk, which frees disk space and bandwidth for other tasks. When the buffer is
+full, |TS| drops log entries and issues an error message indicating how many
+entries were dropped. Because |TS| only writes complete log entries to the
+pipe, only full records are dropped.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/logging/summary-logs.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/logging/summary-logs.en.rst b/doc/admin-guide/monitoring/logging/summary-logs.en.rst
new file mode 100644
index 0000000..7fd1bf8
--- /dev/null
+++ b/doc/admin-guide/monitoring/logging/summary-logs.en.rst
@@ -0,0 +1,84 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../common.defs
+
+.. _admin-monitoring-logging-summary-logs:
+
+Summary Logs
+************
+
+Due to the speed and efficiency of |TS|, a heavily-loaded node will generate
+many events and the event logs can quickly grow to very large sizes.  Using
+SQL-like aggregate operators, you can configure |TS| to create summary log
+files that summarize a set of log entries over a specified period of time. This
+can significantly reduce the size of the log files generated.
+
+To generate a summary log file, create a :ref:`LogFormat` object in the
+XML-based logging configuration :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.
+
+-  ``COUNT``
+-  ``SUM``
+-  ``AVERAGE``
+-  ``FIRST``
+-  ``LAST``
+
+To create a summary log file format:
+
+#. Define the format of the log file in :file:`logs_xml.config` as follows:
+
+   .. code-block:: xml
+
+       <LogFormat>
+         <Name = "summary"/>
+         <Format = "%<operator(field)> : %<operator(field)>"/>
+         <Interval = "n"/>
+       </LogFormat>
+
+   Where ``operator`` is one of the five aggregate operators (``COUNT``,
+   ``SUM``, ``AVERAGE``, ``FIRST``, ``LAST``); ``field`` 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 :file:`logs_xml.config`.
+
+#. 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:
+
+.. code-block:: 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: ::
+
+        <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)> : %<cqu>"/>
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/logging/understanding.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/logging/understanding.en.rst b/doc/admin-guide/monitoring/logging/understanding.en.rst
new file mode 100644
index 0000000..f9a56f6
--- /dev/null
+++ b/doc/admin-guide/monitoring/logging/understanding.en.rst
@@ -0,0 +1,83 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../common.defs
+
+.. _admin-monitoring-logging-understanding:
+
+Understanding |TS| Log Files
+****************************
+
+|TS| records information about every transaction (or request) it processes and
+every error it detects in log files. |TS| keeps three types of log files:
+
+-  *Error log files* record information about why a particular
+   transaction was in error.
+
+-  *Event log files* (also called *access log files*) record
+   information about the state of each transaction Traffic Server
+   processes.
+
+-  *System log files* record system information, including messages
+   about the state of Traffic Server and errors/warnings it produces.
+   This kind of information might include a note that event log files
+   were rolled, a warning that cluster communication timed out, or an
+   error indicating that Traffic Server was restarted.
+
+   All system information messages are logged with the system-wide
+   logging facility :manpage:`syslog` under the daemon facility. The
+   :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 :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`).
+
+   System information logs observe a static format. Each log entry in
+   the log contains information about the date and time the error was
+   logged, the hostname of the Traffic Server that reported the error,
+   and a description of the error or warning.
+
+   Refer to :ref:`traffic-server-error-messages` for a list of the
+   messages logged by Traffic Server.
+
+By default, |TS| 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
+:ts:cv:`proxy.config.log.logging_enabled` in :file:`records.config`
+to one of the following values:
+
+======= =================================================
+Value   Description
+======= =================================================
+``0``   Disable both event and error logging.
+``1``   Enable error logging only.
+``2``   Enable event logging only.
+``3``   Enable both event and error logging.
+======= =================================================
+
+By analyzing the log files, you can determine how many people use the |TS|
+cache, how much information each person requested, what pages are most popular,
+and so on. |TS| supports several standard log file formats, such as Squid and
+Netscape, as well as user-defined custom formats. You can analyze the standard
+format log files with off-the-shelf analysis packages. To help with log file
+analysis, you can separate log files so they contain information specific to
+protocol or hosts. You can also configure |TS| to roll log files automatically
+at specific intervals during the day or when they reach a certain size.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/monitoring/builtin.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/monitoring/builtin.en.rst b/doc/admin-guide/monitoring/monitoring/builtin.en.rst
new file mode 100644
index 0000000..1040fca
--- /dev/null
+++ b/doc/admin-guide/monitoring/monitoring/builtin.en.rst
@@ -0,0 +1,24 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../common.defs
+
+.. _admin-monitoring-monitoring-builtin:
+
+Using Built-in Tools
+********************
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/monitoring/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/monitoring/index.en.rst b/doc/admin-guide/monitoring/monitoring/index.en.rst
new file mode 100644
index 0000000..0a4d312
--- /dev/null
+++ b/doc/admin-guide/monitoring/monitoring/index.en.rst
@@ -0,0 +1,30 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../common.defs
+
+.. _admin-monitoring-monitoring:
+
+Monitoring
+**********
+
+.. toctree::
+   :maxdepth: 2
+
+   builtin.en
+   third-party/index.en
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst b/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst
new file mode 100644
index 0000000..fb52da9
--- /dev/null
+++ b/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst
@@ -0,0 +1,32 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-monitoring-monitoring-third-party:
+
+Integrating Third-Party Tools
+*****************************
+
+.. toctree::
+   :maxdepth: 2
+
+   circonus.en
+   logstash.en
+   nagios.en
+   zabbix.en
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/accessing.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/accessing.en.rst b/doc/admin-guide/monitoring/statistics/accessing.en.rst
new file mode 100644
index 0000000..efa991b
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/accessing.en.rst
@@ -0,0 +1,119 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../common.defs
+
+.. _admin-stats-accessing:
+
+Accessing Statistics
+********************
+
+There are currently two methods provided with |TS| to view statistics:
+:ref:`admin-stats-traffic-line` and :ref:`admin-stats-stats-over-http`.
+
+.. _admin-stats-traffic-line:
+
+Traffic Line
+============
+
+The command line utility :program:`traffic_line` offers a text based interface
+for viewing |TS| statistics. Invocation is simple and requires knowing the
+specific name of the statistic you wish you view::
+
+    traffic_line -r <statistic name>
+
+You may notice that this is the same utility, and argument, used for viewing
+configuration variables of a running |TS| instance. Unlike configuration
+variables, you cannot modify a statistic value with the :program:`traffic_line`
+program.
+
+This utility is enabled and built by default, and will be located in the
+``bin/`` subdirectory of your |TS| installation. There are no required changes
+to your configuration to allow :program:`traffic_line` to function, however it
+may only be run by users with permissions to access the |TS| Unix socket. This
+will typically limit use to root as well as the system user you have configured
+|TS| to run under or any other system users which share the same group as you
+have configured |TS| to use.
+
+.. _admin-stats-stats-over-http:
+
+Stats Over HTTP
+===============
+
+|TS| includes a stable plugin, :ref:`admin-plugins-stats-over-http`, which provides
+HTTP access to all |TS| statistcs. The plugin returns a JSON object with all
+statistics and their current values. It is not possible to return a subset of
+the statistics. The plugin must be enabled before you may use it.
+
+.. _admin-stats-stats-over-http-enabling:
+
+Enabling Stats Over HTTP
+------------------------
+
+To enable the :ref:`admin-plugins-stats-over-http` plugin, you must add the
+following to your :file:`plugin.config`::
+
+    stats_over_http.so
+
+Once the plugin is enabled and |TS| has reloaded, you can test that it is
+working properly by issuing a simple HTTP request with ``curl``. Assuming your
+|TS| installation is using the default interface and port bindings, running the
+following command on the same host as |TS| should now work::
+
+    curl http://localhost:8080/_stats
+
+You should be presented with an HTTP response containing a single JSON object
+which lists all the available statistics and their current values. If you have
+configured |TS| to only listen on a specific interface, or to use a different
+port, you may need to adjust the URL in the command above.
+
+If you wish to have the stats made available at a non-default path, then that
+path should be given as the sole argument to the plugin, as so::
+
+    stats_over_http.so 81c075bc0cca1435ea899ba4ad72766b
+
+The above :file:`plugin.config` entry will result in your |TS| statistics being
+located at ``/81c075bc0cca1435ea899ba4ad72766b`` on any host and port on which
+you have your |TS| instance listening.
+
+.. _admin-stats-stats-over-http-security:
+
+Statistics Security and Privacy
+-------------------------------
+
+Simply changing the path at which your statistics are available should be
+considered very weak security. While cache objects themselves cannot be
+accessed through the plugin's JSON output, and no modifications to the
+configuration or operation of |TS| may be made through the plugin, the
+statistics may reveal much more about your network's traffic and architecture
+than you wish to be publicly available.
+
+A better method is to use an :ref:`ACL Filter <remap-config-named-filters>` in
+:file:`remap.config` to restrict access to clients. For instance, if your |TS|
+host resides on a private network in the 10.1.1.0/24 IPv4 address space
+listening on the address 10.1.1.10, separate from its public interface(s) used
+to serve client requests, you could add the following remap configuration::
+
+    map http://10.1.1.10/_stats http://10.1.1.10/_stats @action=deny @src_ip=0.0.0.0-255.255.255.255
+    map http://10.1.1.10/_stats http://10.1.1.10/_stats @action=allow @src_ip=10.1.1.0-10.1.1.255
+
+The above configuration sets the default policy for the entirety of IPv4 address
+space to deny, but then exempts the 10.1.1.0/24 network by permitting their
+requests to be processed by |TS|. If your monitoring infrastructure makes use
+of locally-installed data collection agents, you may even wish to restrict
+access to the Stats Over HTTP plugin to all but localhost.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core-statistics.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core-statistics.en.rst b/doc/admin-guide/monitoring/statistics/core-statistics.en.rst
new file mode 100644
index 0000000..abb8ccc
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core-statistics.en.rst
@@ -0,0 +1,55 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../common.defs
+
+.. _admin-stats-core:
+
+Core Statistics
+***************
+
+Core statistics are available regardless of which plugins are enabled. This
+section breaks them down into categories based on the general |TS| function or
+component to which they're related.
+
+.. toctree::
+   :maxdepth: 2
+
+   core/general.en
+   core/log.en
+   core/cache.en
+   core/cache-volume.en
+   core/hierarchical.en
+   core/hostdb.en
+   core/dns.en
+   core/cluster.en
+   core/origin.en
+   core/network-io.en
+   core/ssl.en
+   core/ssl-cipher.en
+   core/http-transaction.en
+   core/http-response-code.en
+   core/http-request-method.en
+   core/http-connection.en
+   core/http-document-size.en
+   core/http-header.en
+   core/bandwidth.en
+   core/congestion.en
+   core/socks.en
+   core/websocket.en
+   core/misc.en
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/bandwidth.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/bandwidth.en.rst b/doc/admin-guide/monitoring/statistics/core/bandwidth.en.rst
new file mode 100644
index 0000000..200cc8c
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/bandwidth.en.rst
@@ -0,0 +1,132 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-bandwidth:
+
+Bandwidth and Transfer
+**********************
+
+.. ts:stat:: global proxy.node.bandwidth_hit_ratio_avg_10s float
+   :type: derivative
+   :unit: ratio
+
+   The difference of :ts:stat:`proxy.node.user_agent_total_bytes_avg_10s` and
+   :ts:stat:`proxy.node.origin_server_total_bytes_avg_10s`, divided by
+   :ts:stat:`proxy.node.user_agent_total_bytes_avg_10s`.
+
+   Represents the ratio of bytes served to user agents which were satisfied by
+   cache hits, over the previous 10 seconds,
+
+.. ts:stat:: global proxy.node.bandwidth_hit_ratio_avg_10s_int_pct integer
+   :type: derivative
+   :unit: percent
+
+   The percentage value of :ts:stat:`proxy.node.bandwidth_hit_ratio_avg_10s`
+   converted to an integer.
+
+.. ts:stat:: global proxy.node.bandwidth_hit_ratio_int_pct integer
+   :type: derivative
+   :unit: percent
+
+   The percentage vaue of :ts:stat:`proxy.node.bandwidth_hit_ratio` converted
+   to an integer.
+
+.. ts:stat:: global proxy.node.bandwidth_hit_ratio float
+   :type: derivative
+   :unit: ratio
+
+   The difference of :ts:stat:`proxy.node.user_agent_total_bytes` and
+   :ts:stat:`proxy.node.origin_server_total_bytes`, divided by
+   :ts:stat:`proxy.node.user_agent_total_bytes`.
+
+   Represents the ratio of bytes served to user agents which were satisfied by
+   cache hits, since statistics collection began.
+
+.. ts:stat:: global proxy.node.client_throughput_out float
+   :type: gauge
+   :unit: mbits
+
+   The value of :ts:stat:`proxy.node.http.throughput` represented in megabits.
+
+.. ts:stat:: global proxy.node.client_throughput_out_kbit integer
+   :type: gauge
+   :unit: kbits
+
+   The value of :ts:stat:`proxy.node.http.throughput` represented in kilobits.
+
+.. ts:stat:: global proxy.node.http.throughput integer
+   :type: gauge
+   :unit: bytes
+
+   The throughput of responses to user agents over the previous 10 seconds, in
+   bytes.
+
+.. ts:stat:: global proxy.process.http.throttled_proxy_only integer
+.. ts:stat:: global proxy.process.http.user_agent_request_document_total_size integer
+   :type: counter
+   :unit: bytes
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.user_agent_request_header_total_size integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.http.user_agent_response_document_total_size integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.http.user_agent_response_header_total_size integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.http.user_agent_speed_bytes_per_sec_100 integer
+   :type: derivative
+   :unit; bytes
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.user_agent_speed_bytes_per_sec_100K integer
+   :type: derivative
+   :unit; bytes
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.user_agent_speed_bytes_per_sec_100M integer
+   :type: derivative
+   :unit; bytes
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.user_agent_speed_bytes_per_sec_10K integer
+   :type: derivative
+   :unit; bytes
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.user_agent_speed_bytes_per_sec_10M integer
+   :type: derivative
+   :unit; bytes
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.user_agent_speed_bytes_per_sec_1K integer
+   :type: derivative
+   :unit; bytes
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.user_agent_speed_bytes_per_sec_1M integer
+   :type: derivative
+   :unit; bytes
+   :ungathered:
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/cache-volume.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/cache-volume.en.rst b/doc/admin-guide/monitoring/statistics/core/cache-volume.en.rst
new file mode 100644
index 0000000..63b62f4
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/cache-volume.en.rst
@@ -0,0 +1,206 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-cache-volume:
+
+Cache Volume
+************
+
+Each configured :ref:`cache-volume` receives a complete set of statistics from
+|TS|. They are differentiated from each other by the incrementing number that is
+part of the statistic name. The volume number begins at :literal:`0` and
+increments by :literal:`1` for each additional volume.
+
+The statistics are documented in this section using the default volume number in
+a configuration with only one cache volume: :literal:`0`.
+
+.. ts:stat:: global proxy.process.cache.volume_0.bytes_total integer
+   :type: gauge
+   :unit: bytes
+
+   Represents the total number of bytes allocated for the cache volume.
+
+.. ts:stat:: global proxy.process.cache.volume_0.bytes_used integer
+   :type: gauge
+   :unit: bytes
+
+   Represents the number of bytes in this cache volume which are occupied by
+   cache objects.
+
+.. ts:stat:: global proxy.process.cache.volume_0.directory_collision integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.direntries.total integer
+   :type: gauge
+
+   Represents the total number of directory entries which have been allocated
+   in this cache volume.
+
+.. ts:stat:: global proxy.process.cache.volume_0.direntries.used integer
+   :type: gauge
+
+   Represents the number of allocated directory entries in this cache volume
+   which are in use.
+
+.. ts:stat:: global proxy.process.cache.volume_0.evacuate.active integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.evacuate.failure integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.evacuate.success integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.frags_per_doc.1 integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.frags_per_doc.2 integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.frags_per_doc.3+ integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.gc_bytes_evacuated integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.gc_frags_evacuated integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.hdr_marshal_bytes integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.hdr_marshals integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.lookup.active integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.lookup.failure integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.lookup.success integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.percent_full integer
+   :type: gauge
+   :unit: percent
+
+.. ts:stat:: global proxy.process.cache.volume_0.pread_count integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.ram_cache.bytes_used integer
+   :type: gauge
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.cache.volume_0.ram_cache.hits integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cache.volume_0.ram_cache.misses integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cache.volume_0.ram_cache.total_bytes integer
+   :type: gauge
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.cache.volume_0.read.active integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cache.volume_0.read_busy.failure integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cache.volume_0.read_busy.success integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cache.volume_0.read.failure integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cache.volume_0.read.success integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cache.volume_0.remove.active integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.remove.failure integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.remove.success integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.scan.active integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.scan.failure integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.scan.success integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.update.active integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.update.failure integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.update.success integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.vector_marshals integer
+   :type: gauge
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.write.active integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cache.volume_0.write.backlog.failure integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cache.volume_0.write_bytes_stat integer
+   :type: counter
+   :unit: bytes
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.volume_0.write.failure integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cache.volume_0.write.success integer
+   :type: counter
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/cache.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/cache.en.rst b/doc/admin-guide/monitoring/statistics/core/cache.en.rst
new file mode 100644
index 0000000..76e2234
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/cache.en.rst
@@ -0,0 +1,291 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-cache:
+
+Cache
+*****
+
+.. ts:stat:: global proxy.node.cache.bytes_free integer
+
+   The difference between :ts:stat:`proxy.process.cache.bytes_total` and
+   :ts:stat:`proxy.process.cache.bytes_used`.
+
+   Represents the amount of space allocated to the cache which is not currently
+   in use by objects.
+
+.. ts:stat:: global proxy.node.cache.bytes_free_mb integer
+
+   The value of :ts:stat:`proxy.node.cache.bytes_free` expressed in megabytes.
+
+.. ts:stat:: global proxy.node.cache.bytes_total integer
+
+   The total number of bytes allocated to the cache.
+
+.. ts:stat:: global proxy.node.cache.bytes_total_mb integer
+
+   The value of :ts:stat:`proxy.node.cache.bytes_total` expressed in megabytes.
+
+.. ts:stat:: global proxy.node.cache.contents.num_docs integer
+   :ungathered:
+
+   Represents the number of documents currently residing in the cache.
+
+.. ts:stat:: global proxy.node.cache_hit_mem_ratio_avg_10s float
+
+   Represents the ratio of cache lookups over the previous 10 seconds which
+   have been satisfied by the in-memory cache, thus avoiding disk cache I/O.
+
+.. ts:stat:: global proxy.node.cache_hit_mem_ratio_avg_10s_int_pct integer
+   :ungathered:
+
+   The value of :ts:stat:`proxy.node.cache_hit_mem_ratio_avg_10s` converted to
+   an integer percent.
+
+.. ts:stat:: global proxy.node.cache_hit_mem_ratio float
+
+   Represents the ratio of cache lookups which have been satisfied by the
+   in-memory cache since statistics collection began.
+
+.. ts:stat:: global proxy.node.cache_hit_mem_ratio_int_pct integer
+   :ungathered:
+
+   The value of :ts:stat:`proxy.node.cache_hit_mem_ratio` converted to an
+   integer percent.
+
+.. ts:stat:: global proxy.node.cache_hit_ratio_avg_10s float
+
+   Represents the ratio of cache lookups over the previous 10 seconds which
+   have been satisfied by either the in-memory cache or the disk cache, thus
+   avoiding revalidation or object retrieval from origin servers.
+
+.. ts:stat:: global proxy.node.cache_hit_ratio_avg_10s_int_pct integer
+
+   The value of :ts:stat:`proxy.node.cache_hit_ratio_avg_10s` converted to an
+   integer percent.
+
+.. ts:stat:: global proxy.node.cache_hit_ratio float
+
+   Represents the ratio of cache lookups which have been satisfied by either the
+   in-memory cache or the on-disk cache since statistics collection began.
+
+.. ts:stat:: global proxy.node.cache_hit_ratio_int_pct integer
+
+   The value of :ts:stat:`proxy.node.cache_hit_ratio` converted to an integer
+   percent.
+
+.. ts:stat:: global proxy.node.cache.percent_free float
+
+   Represents the percentage of allocated cache space which is not occupied by
+   cache objects.
+
+.. ts:stat:: global proxy.node.cache.percent_free_int_pct integer
+
+   The value of :ts:stat:`proxy.node.cache.percent_free` converted to an
+   integer percent.
+
+.. ts:stat:: global proxy.node.cache_total_hits_avg_10s float
+.. ts:stat:: global proxy.node.cache_total_hits integer
+
+   Represents the total number of cache lookups which have been satisfied by
+   either the in-memory cache or the on-disk cache, since statistics collection
+   began.
+
+.. ts:stat:: global proxy.node.cache_total_hits_mem_avg_10s float
+.. ts:stat:: global proxy.node.cache_total_hits_mem integer
+
+   Represents the total number of cache lookups which have been satisfied by the
+   in-memory cache, since statistics collection began.
+
+.. ts:stat:: global proxy.node.cache_total_misses_avg_10s float
+.. ts:stat:: global proxy.node.cache_total_misses integer
+
+   Represents the total number of cache lookups which could not be satisfied by
+   either the in-memory cache or the on-disk cache, and which required origin
+   server revalidation or retrieval.
+
+.. ts:stat:: global proxy.node.http.cache_current_connections_count integer
+.. ts:stat:: global proxy.node.http.cache_hit_fresh_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_hit_ims_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_hit_mem_fresh_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_hit_revalidated_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_hit_stale_served_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_miss_changed_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_miss_client_no_cache_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_miss_cold_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_miss_ims_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_miss_not_cacheable_avg_10s float
+.. ts:stat:: global proxy.node.http.cache_read_error_avg_10s float
+.. ts:stat:: global proxy.process.cache.bytes_total integer
+.. ts:stat:: global proxy.process.cache.bytes_used integer
+.. ts:stat:: global proxy.process.cache.directory_collision integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.direntries.total integer
+.. ts:stat:: global proxy.process.cache.direntries.used integer
+.. ts:stat:: global proxy.process.cache.evacuate.active integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.evacuate.failure integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.evacuate.success integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.frags_per_doc.1 integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.frags_per_doc.2 integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.frags_per_doc.3+ integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.gc_bytes_evacuated integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.gc_frags_evacuated integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.hdr_marshal_bytes integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.hdr_marshals integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.KB_read_per_sec float
+.. ts:stat:: global proxy.process.cache.KB_write_per_sec float
+.. ts:stat:: global proxy.process.cache.lookup.active integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.lookup.failure integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.lookup.success integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.percent_full integer
+.. ts:stat:: global proxy.process.cache.pread_count integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.ram_cache.bytes_used integer
+.. ts:stat:: global proxy.process.cache.ram_cache.hits integer
+.. ts:stat:: global proxy.process.cache.ram_cache.misses integer
+.. ts:stat:: global proxy.process.cache.ram_cache.total_bytes integer
+.. ts:stat:: global proxy.process.cache.read.active integer
+.. ts:stat:: global proxy.process.cache.read_busy.failure integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.read_busy.success integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.read.failure integer
+.. ts:stat:: global proxy.process.cache.read_per_sec float
+.. ts:stat:: global proxy.process.cache.read.success integer
+.. ts:stat:: global proxy.process.cache.remove.active integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.remove.failure integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.remove.success integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.scan.active integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.scan.failure integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.scan.success integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.cache.update.active integer
+.. ts:stat:: global proxy.process.cache.update.failure integer
+.. ts:stat:: global proxy.process.cache.update.success integer
+.. ts:stat:: global proxy.process.cache.vector_marshals integer
+.. ts:stat:: global proxy.process.cache.write.active integer
+.. ts:stat:: global proxy.process.cache.write.backlog.failure integer
+.. ts:stat:: global proxy.process.cache.write_bytes_stat integer
+.. ts:stat:: global proxy.process.cache.write.failure integer
+.. ts:stat:: global proxy.process.cache.write_per_sec float
+.. ts:stat:: global proxy.process.cache.write.success integer
+.. ts:stat:: global proxy.process.http.background_fill_bytes_aborted_stat integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.background_fill_bytes_completed_stat integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.background_fill_current_count integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.cache_deletes integer
+.. ts:stat:: global proxy.process.http.cache_hit_fresh integer
+.. ts:stat:: global proxy.process.http.cache_hit_ims integer
+.. ts:stat:: global proxy.process.http.cache_hit_mem_fresh integer
+.. ts:stat:: global proxy.process.http.cache_hit_revalidated integer
+.. ts:stat:: global proxy.process.http.cache_hit_stale_served integer
+.. ts:stat:: global proxy.process.http.cache_lookups integer
+.. ts:stat:: global proxy.process.http.cache_miss_changed integer
+.. ts:stat:: global proxy.process.http.cache_miss_client_no_cache integer
+.. ts:stat:: global proxy.process.http.cache_miss_client_not_cacheable integer
+.. ts:stat:: global proxy.process.http.cache_miss_cold integer
+.. ts:stat:: global proxy.process.http.cache_miss_ims integer
+.. ts:stat:: global proxy.process.http.cache_read_error integer
+.. ts:stat:: global proxy.process.http.cache_read_errors integer
+.. ts:stat:: global proxy.process.http.cache_updates integer
+.. ts:stat:: global proxy.process.http.cache_write_errors integer
+.. ts:stat:: global proxy.process.http.cache_writes integer
+.. ts:stat:: global proxy.process.http.tcp_client_refresh_count_stat integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.tcp_client_refresh_origin_server_bytes_stat integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.tcp_client_refresh_user_agent_bytes_stat integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.tcp_expired_miss_count_stat integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.tcp_expired_miss_origin_server_bytes_stat integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.tcp_expired_miss_user_agent_bytes_stat integer
+   :ungathered:
+
+.. ts:stat:: global proxy.process.http.tcp_hit_count_stat integer
+.. ts:stat:: global proxy.process.http.tcp_hit_origin_server_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_hit_user_agent_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_ims_hit_count_stat integer
+.. ts:stat:: global proxy.process.http.tcp_ims_hit_origin_server_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_ims_hit_user_agent_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_ims_miss_count_stat integer
+.. ts:stat:: global proxy.process.http.tcp_ims_miss_origin_server_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_ims_miss_user_agent_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_miss_count_stat integer
+.. ts:stat:: global proxy.process.http.tcp_miss_origin_server_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_miss_user_agent_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_refresh_hit_count_stat integer
+.. ts:stat:: global proxy.process.http.tcp_refresh_hit_origin_server_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_refresh_hit_user_agent_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_refresh_miss_count_stat integer
+.. ts:stat:: global proxy.process.http.tcp_refresh_miss_origin_server_bytes_stat integer
+.. ts:stat:: global proxy.process.http.tcp_refresh_miss_user_agent_bytes_stat integer
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/cluster.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/cluster.en.rst b/doc/admin-guide/monitoring/statistics/core/cluster.en.rst
new file mode 100644
index 0000000..1bce07b
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/cluster.en.rst
@@ -0,0 +1,209 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-cluster:
+
+Cluster
+*******
+
+The statistics documented in this section relate to |TS| clusters, which are
+synchronized sets of |TS| instances running across multiple hosts. For more
+information on configuring and using the clustering feature, please refer to
+the :ref:`traffic-server-cluster` chapter of the :ref:`admin-guide`.
+
+.. ts:stat:: global proxy.node.cluster.nodes integer
+   :type: gauge
+
+   Represents the number of |TS| instances which are members of the same cluster
+   as this node.
+
+.. ts:stat:: global proxy.process.cluster.alloc_data_news integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.byte_bank_used integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.cache_callbacks integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.cache_callback_time float
+.. ts:stat:: global proxy.process.cluster.cache_outstanding integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.chan_inuse integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.cluster_ping_time float
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.configuration_changes integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.connections_avg_time float
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.connections_bumped integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.connections_closed integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.connections_opened integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.connections_open integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.connections_read_locked integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.connections_write_locked integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.control_messages_avg_receive_time float
+.. ts:stat:: global proxy.process.cluster.control_messages_avg_send_time float
+.. ts:stat:: global proxy.process.cluster.control_messages_received integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.control_messages_sent integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.delayed_reads integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.level1_bank integer
+.. ts:stat:: global proxy.process.cluster.lkrmt_cache_callbacks integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.lkrmt_cache_callback_time float
+.. ts:stat:: global proxy.process.cluster.local_connections_closed integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.local_connection_time float
+.. ts:stat:: global proxy.process.cluster.machines_allocated integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.machines_freed integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.multilevel_bank integer
+.. ts:stat:: global proxy.process.cluster.net_backup integer
+.. ts:stat:: global proxy.process.cluster.nodes integer
+   :type: gauge
+
+.. ts:stat:: global proxy.process.cluster.no_remote_space integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.op_delayed_for_lock integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.open_delays integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.open_delay_time float
+.. ts:stat:: global proxy.process.cluster.partial_reads integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.partial_writes integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.rdmsg_assemble_time float
+.. ts:stat:: global proxy.process.cluster.read_bytes integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.cluster.reads integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.remote_connections_closed integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.remote_connection_time float
+.. ts:stat:: global proxy.process.cluster.remote_op_reply_timeouts integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.remote_op_timeouts integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.rmt_cache_callbacks integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.rmt_cache_callback_time float
+.. ts:stat:: global proxy.process.cluster.setdata_no_cachevc integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.setdata_no_cluster integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.setdata_no_clustervc integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.setdata_no_tunnel integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.slow_ctrl_msgs_sent integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_cache_insert_lock_misses integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_cache_inserts integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_cache_lookup_hits integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_cache_lookup_lock_misses integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_cache_lookup_misses integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_cache_purges integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_cache_scan_lock_misses integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_cache_scans integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_read_list_len integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_write_list_len integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.vc_write_stall integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.write_bb_mallocs integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.write_bytes integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.cluster.write_lock_misses integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.cluster.writes integer
+   :type: counter
+
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/congestion.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/congestion.en.rst b/doc/admin-guide/monitoring/statistics/core/congestion.en.rst
new file mode 100644
index 0000000..c99478c
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/congestion.en.rst
@@ -0,0 +1,30 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-congestion:
+
+Congestion
+**********
+
+.. ts:stat:: global proxy.process.congestion.congested_on_conn_failures integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.congestion.congested_on_max_connection integer
+   :type: counter
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/dns.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/dns.en.rst b/doc/admin-guide/monitoring/statistics/core/dns.en.rst
new file mode 100644
index 0000000..4dce93f
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/dns.en.rst
@@ -0,0 +1,102 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-dns:
+
+DNS
+***
+
+.. ts:stat:: global proxy.node.dns.lookup_avg_time_ms integer
+   :type: derivative
+   :unit: milliseconds
+   :ungathered:
+
+   Average number of milliseconds spent performing DNS lookups per host.
+
+.. ts:stat:: global proxy.node.dns.lookups_per_second float
+   :type: derivative
+   :ungathered:
+
+   The average number of DNS lookups performance per second.
+
+.. ts:stat:: global proxy.node.dns.total_dns_lookups integer
+   :type: counter
+   :ungathered:
+
+   Total number of DNS lookups performance since statistics collection began.
+
+.. ts:stat:: global proxy.process.dns.fail_avg_time integer
+   :type: derivative
+   :unit: milliseconds
+   :ungathered:
+
+   The average time per DNS lookup, in milliseconds, which ultimately failed.
+
+.. ts:stat:: global proxy.process.dns.in_flight integer
+   :type: gauge
+   :ungathered:
+
+   The number of DNS lookups currently in progress.
+
+.. ts:stat:: global proxy.process.dns.lookup_avg_time integer
+   :type: derivative
+   :unit: milliseconds
+   :ungathered:
+
+   The average time spent performaning DNS lookups per host.
+
+.. ts:stat:: global proxy.process.dns.lookup_failures integer
+   :type: counter
+   :ungathered:
+
+   The total number of DNS lookups which have failed since statistics collection
+   began.
+
+.. ts:stat:: global proxy.process.dns.lookup_successes integer
+   :type: counter
+   :ungathered:
+
+   The total number of DNS lookups which have succeeded since statistics
+   collection began.
+
+.. ts:stat:: global proxy.process.dns.max_retries_exceeded integer
+   :type: counter
+   :ungathered:
+
+   The number of DNS lookups which have been failed due to the maximum number
+   of retries being exceeded.
+
+.. ts:stat:: global proxy.process.dns.retries integer
+   :type: counter
+   :ungathered:
+
+.. ts:stat:: global proxy.process.dns.success_avg_time integer
+   :type: derivative
+   :unit: milliseconds
+   :ungathered:
+
+   The average time per DNS lookup, in milliseconds, which have succeeded.
+
+.. ts:stat:: global proxy.process.dns.total_dns_lookups integer
+   :type: counter
+   :ungathered:
+
+   The total number of DNS lookups which have been performed since statistics
+   collection began.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/general.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/general.en.rst b/doc/admin-guide/monitoring/statistics/core/general.en.rst
new file mode 100644
index 0000000..547801a
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/general.en.rst
@@ -0,0 +1,124 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-general:
+
+General
+*******
+
+.. ts:stat:: global server string 5.3.0
+
+   Human-readable version number string for the currently running |TS| instance.
+
+.. ts:stat:: global proxy.node.config.reconfigure_required integer
+   :type: flag
+
+.. ts:stat:: global proxy.node.config.reconfigure_time integer
+
+.. ts:stat:: global proxy.node.config.restart_required.cop integer
+   :type: flag
+
+.. ts:stat:: global proxy.node.config.restart_required.manager integer
+   :type: flag
+
+.. ts:stat:: global proxy.node.config.restart_required.proxy integer
+   :type: flag
+
+.. ts:stat:: global proxy.node.hostname_FQ string ats-host.example.com
+
+   Fully-qualified domain name for the host on which |TS| is running.
+
+.. ts:stat:: global proxy.node.hostname string ats-host
+
+   The hostname only, without domain, for the host on which |TS| is running.
+
+.. ts:stat:: global proxy.node.num_processes integer
+   :type: gauge
+
+   The number of :program:`traffic_server` processes running on the host.
+
+.. ts:stat:: global proxy.node.proxy_running integer
+   :type: flag
+
+   Indicates whether any form of HTTP proxying is currently enabled in the
+   running instance of |TS|.
+
+.. ts:stat:: global proxy.node.restarts.manager.start_time integer
+   :type: gauge
+   :unit: seconds
+
+   Unix epoch-time value indicating the time at which the currently-running
+   :program:`traffic_manager` process was started.
+
+.. ts:stat:: global proxy.node.restarts.proxy.cache_ready_time integer
+   :type: gauge
+   :unit: seconds
+
+.. ts:stat:: global proxy.node.restarts.proxy.restart_count integer
+.. ts:stat:: global proxy.node.restarts.proxy.start_time integer
+.. ts:stat:: global proxy.node.restarts.proxy.stop_time integer
+.. ts:stat:: global proxy.node.user_agents_total_documents_served integer
+.. ts:stat:: global proxy.node.user_agent_total_bytes_avg_10s float
+.. ts:stat:: global proxy.node.user_agent_total_bytes integer
+.. ts:stat:: global proxy.node.user_agent_xacts_per_second float
+.. ts:stat:: global proxy.node.version.manager.build_date string
+.. ts:stat:: global proxy.node.version.manager.build_machine string
+.. ts:stat:: global proxy.node.version.manager.build_number integer
+.. ts:stat:: global proxy.node.version.manager.build_person string
+.. ts:stat:: global proxy.node.version.manager.build_time string
+.. ts:stat:: global proxy.node.version.manager.long string
+.. ts:stat:: global proxy.node.version.manager.short float
+.. ts:stat:: global proxy.process.http.tunnels integer
+.. ts:stat:: global proxy.process.update.fails integer
+.. ts:stat:: global proxy.process.update.no_actions integer
+.. ts:stat:: global proxy.process.update.state_machines integer
+.. ts:stat:: global proxy.process.update.successes integer
+.. ts:stat:: global proxy.process.update.unknown_status integer
+.. ts:stat:: global proxy.process.version.server.build_date string Apr 20 2015
+
+   Date on which the running instance of |TS| was compiled.
+
+.. ts:stat:: global proxy.process.version.server.build_machine string
+
+   The hostname of the machine on which the running instance of |TS| was
+   compiled.
+
+.. ts:stat:: global proxy.process.version.server.build_number string 042020
+
+   The string representation of the |TS| build number for the running instance.
+
+.. ts:stat:: global proxy.process.version.server.build_person string jdoe
+
+   The effective username which compiled the running instance of |TS|.
+
+.. ts:stat:: global proxy.process.version.server.build_time string 20:14:09
+
+   The time at which the running instance of |TS| was compiled.
+
+.. ts:stat:: global proxy.process.version.server.long string Apache Traffic Server - traffic_server - 5.3.0 - (build # 042020 on Apr 20 2015 at 20:14:09)
+
+   A string representing the build information of the running instance of |TS|.
+   Includes the software name, primary binary name, release number, build
+   number, build date, and build time.
+
+.. ts:stat:: global proxy.process.version.server.short float 5.3.0
+
+   A shortened string containing the release number of the running instance of
+   |TS|.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/hierarchical.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/hierarchical.en.rst b/doc/admin-guide/monitoring/statistics/core/hierarchical.en.rst
new file mode 100644
index 0000000..30fda2c
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/hierarchical.en.rst
@@ -0,0 +1,53 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-hierarchical:
+
+Hierarchical Cache
+******************
+
+.. ts:stat:: global proxy.node.http.current_parent_proxy_connections integer
+   :type: counter
+
+.. ts:stat:: global proxy.node.http.parent_proxy_total_request_bytes integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.node.http.parent_proxy_total_response_bytes integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.http.current_parent_proxy_connections integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.http.parent_proxy_request_total_bytes integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.http.parent_proxy_response_total_bytes integer
+   :type: counter
+   :unit: bytes
+
+.. ts:stat:: global proxy.process.http.parent_proxy_transaction_time integer
+   :type: counter
+   :unit: seconds
+
+.. ts:stat:: global proxy.process.http.total_parent_proxy_connections integer
+   :type: counter
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/admin-guide/monitoring/statistics/core/hostdb.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/hostdb.en.rst b/doc/admin-guide/monitoring/statistics/core/hostdb.en.rst
new file mode 100644
index 0000000..e2e2b24
--- /dev/null
+++ b/doc/admin-guide/monitoring/statistics/core/hostdb.en.rst
@@ -0,0 +1,114 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../../../common.defs
+
+.. _admin-stats-core-hostdb:
+
+HostDB
+******
+
+The HostDB component of |TS| manages origin server name resolution and host
+health checks. The statistics documented here can help to ensure that your |TS|
+instances are not spending an unreasonable amount of timing resolving your
+origin servers' hostnames prior to object revalidation or retrieval.
+
+.. ts:stat:: global proxy.node.hostdb.hit_ratio_avg_10s float
+   :type: derivative
+   :unit: ratio
+
+   Represents the ratio of origin server name resolutions which were satisfied
+   by the HostDB lookup cache over the last 10 seconds.
+
+.. ts:stat:: global proxy.node.hostdb.hit_ratio float
+   :type: derivative
+   :unit: ratio
+
+   Represents the ratio of origin server name resolutions which were satisfied
+   by the HostDB lookup cache since statistics collection began.
+
+.. ts:stat:: global proxy.node.hostdb.hit_ratio_int_pct integer
+   :type: derivative
+   :unit: ratio
+
+   The value of :ts:stat:`proxy.node.hostdb.hit_ratio` converted to an integer
+   percent.
+
+.. ts:stat:: global proxy.node.hostdb.total_hits_avg_10s float
+   :type: derivative
+
+   Represents the number of origin server name resolutions which were satisfied
+   by the HostDB lookup cache over the last 10 seconds.
+
+.. ts:stat:: global proxy.node.hostdb.total_hits integer
+   :type: counter
+
+   Represents the total number of origin server name resolutions which were
+   satisfied by entries in the HostDB lookup cache, since statistics collection
+   began.
+
+.. ts:stat:: global proxy.node.hostdb.total_lookups_avg_10s float
+   :type: derivative
+
+   Represents the number of origin server name resolutions which were performed
+   over the last 10 seconds, regardless of whether they were satisfied by the
+   HostDB lookup cache.
+
+.. ts:stat:: global proxy.node.hostdb.total_lookups integer
+   :type: counter
+
+   Represents the total number of origin server name resolutions which have been
+   performed, since statistics collection began, regardless of whether they were
+   satisfied by the HostDB lookup cache or required DNS lookups.
+
+.. ts:stat:: global proxy.process.hostdb.bytes integer
+   :type: counter
+   :unit: bytes
+
+   Represents the number of bytes allocated to the HostDB lookup cache.
+
+.. ts:stat:: global proxy.process.hostdb.re_dns_on_reload integer
+   :type: counter
+
+.. ts:stat:: global proxy.process.hostdb.total_entries integer
+   :type: counter
+
+   Represents the total number of host entries currently in the HostDB lookup
+   cache.
+
+.. ts:stat:: global proxy.process.hostdb.total_hits integer
+   :type: counter
+
+   Represents the total number of origin server name resolutions which were
+   satisfied by entries in the HostDB lookup cache, since statistics collection
+   began.
+
+.. ts:stat:: global proxy.process.hostdb.total_lookups integer
+   :type: counter
+
+   Represents the total number of origin server name resolutions which have been
+   performed, since statistics collection began, regardless of whether they were
+   satisfied by the HostDB lookup cache or required DNS lookups.
+
+.. ts:stat:: global proxy.process.hostdb.ttl_expires integer
+   :type: gauge
+   :unit: seconds
+
+.. ts:stat:: global proxy.process.hostdb.ttl float
+   :type: gauge
+   :unit: seconds
+


Mime
View raw message