[32/48] git commit: doc: document traffic_cop

[zw...@apache.org]

doc: document traffic_cop


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

Branch: refs/heads/5.0.x
Commit: f2882b8e0770cfa3e16e0b2c3f170ab94b4f34e4
Parents: 2c19473
Author: James Peach <jp...@apache.org>
Authored: Sat Sep 7 21:30:20 2013 -0700
Committer: James Peach <jp...@apache.org>
Committed: Sat Sep 7 21:30:20 2013 -0700

----------------------------------------------------------------------
 doc/reference/commands/traffic_cop.en.rst | 28 +++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f2882b8e/doc/reference/commands/traffic_cop.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_cop.en.rst b/doc/reference/commands/traffic_cop.en.rst
index 9dd4e99..a19c2a3 100644
--- a/doc/reference/commands/traffic_cop.en.rst
+++ b/doc/reference/commands/traffic_cop.en.rst
@@ -24,12 +24,38 @@ traffic_cop
 Description
 ===========
 
+:program:`traffic_cop` is a watchdog program that is responsible
+for starting :program:`traffic_manager` and :program:`traffic_server`
+and monitoring them for responsiveness. If either of these processes
+are determined to be unresponsive, :program:`traffic_cop` will kill
+and restart them.
+
+On Linux, :program:`traffic_cop` will also monitor available memory
+and swap space, restarting the watched processes if the available
+memory falls below a minimum threshold. The memory thresholds can
+be configured with the :ts:cv:`proxy.config.cop.linux_min_swapfree_kb`
+and :ts:cv:`proxy.config.cop.linux_min_memfree_kb` variables.
+
+The following options are available:
+
 .. option:: -stop
 
-   Kill children using ``SIGSTOP`` instead of ``SIGKILL``
+   Kill children using ``SIGSTOP`` instead of ``SIGKILL``. This
+   option is primarily for debugging.
 
 .. option:: -V
 
    Print version information and exit.
 
+:program:`traffic_cop` ordinarily logs to syslog, however for
+debugging purposes, the ``--enable-cop-debug`` build option
+causes it to log trace messages to
+:file:`/tmp/traffic_cop.trace`.
+
+See also
+========
+
+:manpage:`syslog(1)`,
+:manpage:`traffic_manager(8)`,
+:manpage:`traffic_server(8)`