[trafficserver] branch 7.1.x updated: Adds some basic documentation for traffic_logstats

[zw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zwoop pushed a commit to branch 7.1.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/7.1.x by this push:
     new dd76ac8  Adds some basic documentation for traffic_logstats
dd76ac8 is described below

commit dd76ac85420e0303352d4b4abc77cca7ee7a567a
Author: Leif Hedstrom <zw...@apache.org>
AuthorDate: Fri Nov 24 10:12:23 2017 +0100

    Adds some basic documentation for traffic_logstats
    
    (cherry picked from commit 18c76c5567d0216b14a12bba0c337c92b3fd543c)
---
 .../command-line/traffic_logstats.en.rst           | 24 +++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/doc/appendices/command-line/traffic_logstats.en.rst b/doc/appendices/command-line/traffic_logstats.en.rst
index ce4a7b0..dfd4153 100644
--- a/doc/appendices/command-line/traffic_logstats.en.rst
+++ b/doc/appendices/command-line/traffic_logstats.en.rst
@@ -22,9 +22,29 @@
 traffic_logstats
 ****************
 
+Synopsis
+========
+
+:program:`traffic_logstats` [options]
+
 Description
 ===========
 
+:program:`traffic_logstats` is a log parsing utility, that is intended to
+produce metrics for total and per origin requests. Currently, this utility
+only supports parsing and processing the Squid binary log format, or a custom
+format that is compatible with the initial log fields of the Squid format.
+
+Output can either be a human readable text file, or a JSON format. Parsing can
+be done incrementally, and :program:`traffic_logstats` supports restarting
+where it left off previously (state is stored in an external file). This is
+useful when collecting metrics periodically into a stats processing system,
+and also supports the case where a log file is rotated.
+
+The per-URL metrics (*-u*) requires that you specify a size of the LRU used
+for keeping the counters. This is to assure that :program:`traffic_logstats`
+does not consume an exorbitant amount of memory.
+
 Options
 =======
 
@@ -42,7 +62,9 @@ Options
 
 .. option:: -U COUNT, --show_urls COUNT
 
-.. option:: --A, --as_object
+.. option:: -A, --as_object
+
+.. option:: -C, --concise
 
 .. option:: -i, --incremental
 

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <co...@trafficserver.apache.org>'].