git commit: TS-1998 Updated the Sphinx docs as well.

[zw...@apache.org]

Updated Branches:
  refs/heads/master 1e0431226 -> f5f9b8e16


TS-1998 Updated the Sphinx docs as well.


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

Branch: refs/heads/master
Commit: f5f9b8e16ca90078562002cfcd0ab34719f50315
Parents: 1e04312
Author: Leif Hedstrom <zw...@apache.org>
Authored: Wed Jul 24 11:49:39 2013 -0600
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Wed Jul 24 11:49:39 2013 -0600

----------------------------------------------------------------------
 doc/plugins/stats_over_http.en.rst | 34 +++++++++++++++++++++++----------
 1 file changed, 24 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f5f9b8e1/doc/plugins/stats_over_http.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/stats_over_http.en.rst b/doc/plugins/stats_over_http.en.rst
index 95ffb49..782aef8 100644
--- a/doc/plugins/stats_over_http.en.rst
+++ b/doc/plugins/stats_over_http.en.rst
@@ -18,20 +18,34 @@ Stats over HTTP Plugin (underdocumented)
   specific language governing permissions and limitations
   under the License.
 
-Statistics are available in JSON format via direct HTTP access to
-Traffic Server.
 
-::
+This plugin implements an HTTP interface to all Traffic Server statistics. The
+metrics returned are in a JSON format, for easy processing. This plugin is now
+part of the standard ATS build process, and should be available after install.
 
-    make
-    sudo make install
+To enable this plugin, add to the plugin.conf file:::
 
-Add the following to
-```plugin.config`` <../../configuration-files/plugin.config>`_:
+  stats_over_http.so
 
-::
 
-    stats_over_http.so
+After starting Traffic Server, the JSON metrics are now available on the
+default URL:::
 
-start traffic server and visit ``http://IP:port/_stats``
+    http://host:port/_stats
 
+
+where host and port is the hostname/IP and port number of the server. You can
+optionally modify the path to use, and this is highly recommended in a public
+facing server. For example:::
+
+    stats_over_http.so 81c075bc0cca1435ea899ba4ad72766b
+
+
+and the URL would then be e.g. ::
+
+    https://host:port/81c075bc0cca1435ea899ba4ad72766b
+
+
+
+This is weak security at best, since the secret could possibly leak if you are
+careless and send it over clear text.