trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject [trafficserver] branch master updated: doc: Remove stale Traffic Line references.
Date Wed, 17 Aug 2016 18:59:51 GMT
This is an automated email from the ASF dual-hosted git repository.

jpeach pushed a commit to branch master
in repository https://git-dual.apache.org/repos/asf/trafficserver.git

The following commit(s) were added to refs/heads/master by this push:
       new  7dc4ff6   doc: Remove stale Traffic Line references.
7dc4ff6 is described below

commit 7dc4ff6c6dbb5645142f9253ff22ae7e564320b3
Author: James Peach <jpeach@apache.org>
AuthorDate: Wed Aug 17 11:32:56 2016 -0700

    doc: Remove stale Traffic Line references.
    
    Remove stale references to Traffic Line. Also remove coupled stats
    documentation since those APIs don't exist.
---
 doc/admin-guide/configuring-traffic-server.en.rst  |   2 +-
 doc/admin-guide/files/records.config.en.rst        |   2 +-
 doc/admin-guide/interaction/index.en.rst           |   4 +-
 doc/admin-guide/introduction.en.rst                |   6 +-
 doc/admin-guide/monitoring/alarms.en.rst           |  15 +--
 .../monitoring/statistics/accessing.en.rst         |   4 +-
 doc/appendices/faq.en.rst                          |   8 +-
 .../plugins/adding-statistics.en.rst               | 126 +--------------------
 8 files changed, 20 insertions(+), 147 deletions(-)

diff --git a/doc/admin-guide/configuring-traffic-server.en.rst b/doc/admin-guide/configuring-traffic-server.en.rst
index d8a36fc..ef6146e 100644
--- a/doc/admin-guide/configuring-traffic-server.en.rst
+++ b/doc/admin-guide/configuring-traffic-server.en.rst
@@ -25,7 +25,7 @@ Traffic Server provides several options for configuring the system.
 .. toctree::
    :maxdepth: 2
 
-.. _configure-using-traffic-line:
+.. _configure-using-traffic-ctl:
 
 Configure Traffic Server
 ========================
diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst
index 04c8de2..33b241b 100644
--- a/doc/admin-guide/files/records.config.en.rst
+++ b/doc/admin-guide/files/records.config.en.rst
@@ -25,7 +25,7 @@ records.config
 The :file:`records.config` file (by default, located in
 ``/usr/local/etc/trafficserver/``) is a list of configurable variables used by
 the |TS| software. Many of the variables in :file:`records.config` are set
-automatically when you set configuration options in Traffic Line. After you
+automatically when you set configuration options with :option:`traffic_ctl config set`. After
you
 modify :file:`records.config`, run the command :option:`traffic_ctl config reload`
 to apply the changes. When you apply changes to one node in a cluster, |TS|
 automatically applies the changes to all other nodes in the cluster.
diff --git a/doc/admin-guide/interaction/index.en.rst b/doc/admin-guide/interaction/index.en.rst
index 87c11d9..7181440 100644
--- a/doc/admin-guide/interaction/index.en.rst
+++ b/doc/admin-guide/interaction/index.en.rst
@@ -25,8 +25,8 @@ Interacting with |TS|
 .. toctree::
    :maxdepth: 2
 
-Traffic Line
-============
+Traffic Control
+===============
 
 Stats Over HTTP
 ===============
diff --git a/doc/admin-guide/introduction.en.rst b/doc/admin-guide/introduction.en.rst
index 14c4183..5da2087 100644
--- a/doc/admin-guide/introduction.en.rst
+++ b/doc/admin-guide/introduction.en.rst
@@ -220,13 +220,11 @@ Traffic Server offers the following administration options:
 
 -  The :program:`traffic_ctl` command-line interface is a
    text-based interface from which you can monitor Traffic Server performance
-   and network traffic, as well as configure the Traffic Server system. From
-   Traffic Line, you can execute individual commands or script a series of
-   commands in a shell.
+   and network traffic, as well as configure the Traffic Server system.
 
 -  Various configuration files enable you to configure Traffic Server
    through a simple file-editing and signal-handling interface. Any
-   changes you make through Traffic Line is
+   changes you make through :program:`traffic_ctl` are
    automatically made to the configuration files as well.
 
 -  Finally, there is a clean C API which can be put to good use from a
diff --git a/doc/admin-guide/monitoring/alarms.en.rst b/doc/admin-guide/monitoring/alarms.en.rst
index 6e58977..f197976 100644
--- a/doc/admin-guide/monitoring/alarms.en.rst
+++ b/doc/admin-guide/monitoring/alarms.en.rst
@@ -48,13 +48,13 @@ alarm is signaled. Traffic Server provides a sample script file named
 ``example_alarm_bin.sh`` in the ``bin`` directory which can serve as the
 basis for your custom alarm scripts.
 
-Viewing Statistics from Traffic Line
-====================================
+Viewing Statistics from Traffic Control
+=======================================
 
-You can use the Traffic Line command-line interface to view statistics
+You can use :program:`traffic_ctl` 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 :ref:`configure-using-traffic-line`
+system. For additional information, refer to :ref:`configure-using-traffic-ctl`
 and :program:`traffic_ctl`. You can view
 specific information about a Traffic Server node or cluster by
 specifying the variable that corresponds to the statistic you want to
@@ -66,15 +66,10 @@ To view a statistic, enter the following command:::
 
 where ``variable`` is the variable representing the information you
 want to view. For a list of variables you can specify, refer to :ref:`Traffic
-Server Metrics <traffic-line-performance-statistics>`.
+Server Metrics <traffic-ctl-performance-statistics>`.
 
 For example, the following command displays the document hit rate for
 the Traffic Server node:::
 
      traffic_ctl metric get proxy.node.cache_hit_ratio
 
-If the Traffic Server ``bin`` directory is not in your path, then
-prepend the Traffic Line command with ``./`` (for example:
-:option:`traffic_ctl metric get` ``VARIABLE``).
-
-
diff --git a/doc/admin-guide/monitoring/statistics/accessing.en.rst b/doc/admin-guide/monitoring/statistics/accessing.en.rst
index aaaba55..b22cf3f 100644
--- a/doc/admin-guide/monitoring/statistics/accessing.en.rst
+++ b/doc/admin-guide/monitoring/statistics/accessing.en.rst
@@ -27,8 +27,8 @@ There are currently two methods provided with |TS| to view statistics:
 
 .. _admin-stats-traffic-line:
 
-Traffic Line
-============
+Traffic Control
+===============
 
 The command line utility :program:`traffic_ctl` offers a text based interface
 for viewing |TS| statistics. Invocation is simple and requires knowing the
diff --git a/doc/appendices/faq.en.rst b/doc/appendices/faq.en.rst
index 4951403..9ddce51 100644
--- a/doc/appendices/faq.en.rst
+++ b/doc/appendices/faq.en.rst
@@ -361,10 +361,10 @@ attributed to the last 10-second interval, although it can take several
 minutes to transfer the object. This inaccuracy is more noticeable with
 a light load. A heavier load yields a more accurate statistic.
 
-You are unable to execute Traffic Line commands
+You are unable to execute Traffic Control commands
 -----------------------------------------------
 
-Traffic Line commands do not execute under the following conditions:
+:program:`traffic_ctl` commands do not execute under the following conditions:
 
 **When the traffic_manager process is not running**
     Check to see if the :program:`traffic_manager` process is running by entering the
@@ -386,10 +386,10 @@ Traffic Line commands do not execute under the following conditions:
 
 **When you are not executing the command from $TSHome/bin**
     If the Traffic Server ``bin`` directory is not in your path, then prepend the
-    Traffic Line commands with ``./`` (for example, ``./traffic_ctl -h``).
+    Traffic Control commands with ``./`` (for example, ``./traffic_ctl -h``).
 
 **When multiple Traffic Server installations are present and you are not
-executing the Traffic Line command from the active Traffic Server path
+executing the Traffic Control command from the active Traffic Server path
 specified in ``/etc/trafficserver``**
 
 
diff --git a/doc/developer-guide/plugins/adding-statistics.en.rst b/doc/developer-guide/plugins/adding-statistics.en.rst
index ffbc622..c899007 100644
--- a/doc/developer-guide/plugins/adding-statistics.en.rst
+++ b/doc/developer-guide/plugins/adding-statistics.en.rst
@@ -27,9 +27,7 @@ can be coupled or uncoupled. *Coupled* statistics are quantities that
 are related and must therefore be updated together. The Traffic Server
 API statistics functions add your plugin's statistics to the Traffic
 Server statistics system. You can view your plugin statistics as you
-would any other Traffic Server statistic, using Traffic Line (Traffic
-Server's command line interface). This chapter contains the following
-topics:
+would any other |TS| statistic, using :program:`traffic_ctl`.
 
 Uncoupled Statistics
 ====================
@@ -54,8 +52,8 @@ To add uncoupled statistics, follow the steps below:
 
 2. In ``TSPluginInit``, create new statistics using ``TSStatCreate``.
    When you create a new statistic, you need to give it an "external"
-   name that the Traffic Server command line interface (Traffic Line)
-   uses to access the statistic. For example:
+   name that :program:`traffic_ctl` uses to access the statistic.
+   For example:
 
    .. code-block:: c
 
@@ -63,121 +61,3 @@ To add uncoupled statistics, follow the steps below:
 
 3. Modify (increment, decrement, or other modification) your statistic
    in plugin functions.
-
-Coupled Statistics
-==================
-
-Use coupled statistics for quantities that are related and therefore
-must be updated jointly.
-
-As a very simple example, suppose you have three statistics: ``sum``,
-``part_1``, and ``part_2``. They must always preserve the relationship
-that ``sum = part_1  + part_2``. If you update ``part_1`` without
-updating ``sum`` at the same time, then the equation becomes untrue.
-Therefore, the statistics are said to be *coupled*.
-
-The mechanism for updating coupled statistics jointly is to create local
-copies of global coupled statistics in the routines that modifiy them.
-When each local copy is updated appropriately, do a global update using
-``TSStatsCoupledUpdate``. To specify which statistics are related to one
-another, establish a coupled statistic category and make sure that each
-coupled statistic belongs to the appropriate category. When it is time
-to do the global update, specify the category to be updated.
-
-.. note::
-
-   The local statistic copy must have a duplicate set of statistics as that
-   of the master copy. Local statistics must also be added to the local
-   statistic category in the same order as their master copy counterparts
-   were originally added.
-
-Below are the steps you need to follow, along with a code example taken
-from the ``redirect-1.c`` sample plugin.
-
-To add coupled statistics
--------------------------
-
-1. Declare the global category for your coupled statistics as a global
-   ``TSCoupledStat`` variable in your plugin.
-
-2. Declare your coupled statistics as global ``TSStat`` variables in
-   your plugin.
-
-3. In ``TSPluginInit``, create a new global coupled category using
-   ``TSStatCoupledGlobalCategoryCreate``.
-
-4. In ``TSPluginInit``, create new global coupled statistics using
-   ``TSStatCoupledGlobalAdd``. When you create a new statistic, you need
-   to give it an "external" name that the Traffic Server command line
-   interface (Traffic Line) uses to access the statistic.
-
-5. In any routine wherein you want to modify (increment, decrement, or
-   other modification) your coupled statistics, declare local copies of
-   the coupled category and coupled statistics.
-
-6. Create local copies using ``TSStatCoupledLocalCopyCreate`` and
-   ``TSStatCoupledLocalAdd``.
-
-7. Modify the local copies of your statistics. Then call
-   ``TSStatsCoupledUpdate`` to update the global copies jointly.
-
-8. When you are finished, you must destroy all of the local copies in
-   the category via ``TSStatCoupledLocalCopyDestroy``.
-
-Example Using the redirect-1.c Sample Plugin
---------------------------------------------
-
-.. code-block:: c
-
-    static TSCoupledStat request_outcomes;
-
-    static TSStat requests_all;
-    static TSStat requests_redirects;
-    static TSStat requests_unchanged;
-
-    request_outcomes = TSStatCoupledGlobalCategoryCreate ("request_outcomes"); 
-
-    requests_all = TSStatCoupledGlobalAdd (request_outcomes, "requests.all", TSSTAT_TYPE_FLOAT);
-    requests_redirects = TSStatCoupledGlobalAdd (request_outcomes, "requests.redirects",
-        TSSTAT_TYPE_INT64);
-    requests_unchanged = TSStatCoupledGlobalAdd (request_outcomes, "requests.unchanged",

-        TSSTAT_TYPE_INT64);
-
-    TSCoupledStat local_request_outcomes;
-    TSStat local_requests_all;
-    TSStat local_requests_redirects;
-    TSStat local_requests_unchanged;
-
-    local_request_outcomes = TSStatCoupledLocalCopyCreate("local_request_outcomes", 
-        request_outcomes); 
-    local_requests_all = TSStatCoupledLocalAdd(local_request_outcomes, "requests.all.local",

-        TSSTAT_TYPE_FLOAT);
-    local_requests_redirects = TSStatCoupledLocalAdd(local_request_outcomes, 
-        "requests.redirects.local", TSSTAT_TYPE_INT64);
-    local_requests_unchanged = TSStatCoupledLocalAdd(local_request_outcomes, 
-        "requests.unchanged.local", TSSTAT_TYPE_INT64);
-
-    TSStatFloatAddTo( local_requests_all, 1.0 ) ; 
-    ...
-    TSStatIncrement (local_requests_unchanged); 
-    TSStatsCoupledUpdate(local_request_outcomes); 
-
-    TSStatCoupledLocalCopyDestroy(local_request_outcomes); 
-
-Viewing Statistics Using Traffic Line
-=====================================
-
-.. XXX: This documentation seems to be duplicated from the admin docs.
-
-To view statistics for your plugin, follow the steps below:
-
-1. Make sure you know the name of your statistic (i.e., the name used in
-   the ``TSStatCoupledGlobalAdd``, ``TSStatCreate``, or
-   ``TSStatCoupledGlobalCategoryCreate`` call).
-
-2. In your ``<Traffic Server>/bin`` directory, enter the following:
-
-   ::
-
-       ./traffic\_line -r the\_name
-

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

Mime
View raw message