[16/25] git commit: adding monitoring-traffic

[ig...@apache.org]

adding monitoring-traffic

This is missing references to stats_over_http :C


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

Branch: refs/heads/sphinx-docs
Commit: 155d07edbcc4e95a844da3ab5a8c6031bfad049c
Parents: bd361e3
Author: Igor Galić <i....@brainsware.org>
Authored: Thu Mar 14 23:09:12 2013 +0100
Committer: Igor Galić <i....@brainsware.org>
Committed: Thu Mar 14 23:09:12 2013 +0100

----------------------------------------------------------------------
 doc/source/admin/monitoring-traffic.en.rst |  109 +++++++++++++++++++++++
 1 files changed, 109 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/155d07ed/doc/source/admin/monitoring-traffic.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/monitoring-traffic.en.rst b/doc/source/admin/monitoring-traffic.en.rst
new file mode 100644
index 0000000..141f853
--- /dev/null
+++ b/doc/source/admin/monitoring-traffic.en.rst
@@ -0,0 +1,109 @@
+:title: Monitoring Traffic
+
+.. 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.
+
+Traffic Server provides several options for monitoring system
+performance and analyzing network traffic.
+
+This chapter discusses the following topics:
+
+.. toctree::
+   :maxdepth: 2
+
+Traffic Server Monitoring Tools
+===============================
+
+Traffic Server provides the following tools to monitor system
+performance and analyze network traffic:
+
+-  Traffic Server can send email that's triggered by alarms that signal
+   any detected failure conditions; refer to `Working with Traffic
+   Manager Alarms <#WorkingTrafficManagerAlarms>`_.
+-  The Traffic Line command-line interface provides an alternative
+   method of viewing Traffic Server performance and network traffic
+   information; refer to `Viewing Statistics from Traffic
+   Line <#ViewingStatisticsTrafficLine>`_.
+-  The Traffic Shell command-line tool provides yet another alternative
+   method of viewing Traffic Server performance and network traffic
+   information; refer to `Starting Traffic
+   Shell <../getting-started#StartTrafficShell>`_.
+
+Working with Traffic Manager Alarms
+===================================
+
+Traffic Server signals an alarm when it detects a problem. For example,
+the space allocated to event logs could be full or Traffic Server may
+not be able to write to a configuration file.
+
+Configuring Traffic Server to Email Alarms
+------------------------------------------
+
+To configure Traffic Server to send an email to a specific address
+whenever an alarm occurs, follow the steps below:
+
+1. In the ```records.config`` <../configuration-files/records.config>`_
+   file
+2. Set the
+   `*``proxy.config.alarm_email``* <../configuration-files/records.config#proxy.config.alarm_email>`_
+   variable to the email address alarms will be routed to.
+3. Run the command ``traffic_line -x`` to apply the configuration
+   changes.
+
+Using a Script File for Alarms
+------------------------------
+
+Alarm messages are built into Traffic Server - you cannot change them.
+However, you can write a script file to execute certain actions when an
+alarm is signaled. Traffic Server provides a sample script file named
+``example_alarm_bin.sh`` in the ``bin`` directory; simply modify the
+file to suit your needs.
+
+Viewing Statistics from Traffic Line
+====================================
+
+You can use the Traffic Line command-line interface to view statistics
+about Traffic Server performance and web traffic. In addition to viewing
+statistics, you can also configure, stop, and restart the Traffic Server
+system. For additional information, refer to `Configuring Traffic Server
+Using Traffic Line <configure.htm#ConfiguringTSUsingTrafficLine>`_ and
+`Traffic Line Commands <../traffic-line-commands>`_. You can view
+specific information about a Traffic Server node or cluster by
+specifying the variable that corresponds to the statistic you want to
+see.
+
+**To view a statistic**, enter the following command:
+
+::
+
+        traffic_line -r variable
+
+where *``variable``* is the variable representing the information you
+want to view. For a list of variables you can specify, refer to `Traffic
+Line Variables <../traffic-line-commands##TrafficLineVariables>`_.
+
+For example, the following command displays the document hit rate for
+the Traffic Server node:
+
+::
+
+     traffic_line -r proxy.node.http.cache_hit_ratio
+
+If the Traffic Server ``bin`` directory is not in your path, then
+prepend the Traffic Line command with ``./`` (for example:
+``./traffic_line -r variable``).
+