trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject [07/51] trafficserver git commit: Documentation reorganization
Date Tue, 03 Nov 2015 06:09:43 GMT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/gzip.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/gzip.en.rst b/doc/reference/plugins/gzip.en.rst
deleted file mode 100644
index bf93688..0000000
--- a/doc/reference/plugins/gzip.en.rst
+++ /dev/null
@@ -1,97 +0,0 @@
-.. _gzip-plugin:
-
-gzip / deflate Plugin
-*********************
-
-.. 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.
-
-
-This plugin gzips or deflates responses, whichever is applicable. It can
-compress origin respones as well as cached responses. The plugin is built
-and installed as part of the normal Apache Traffic Server installation
-process.
-
-Installation
-============
-
-Add the following line to :file:`plugin.config`::
-
-    gzip.so
-
-In this case, the plugin will use the default behaviour:
-
--  Enable caching
--  Compress text/\* for every origin
--  Don't hide accept encoding from origin servers (for an offloading
-   reverse proxy)
--  No urls are disallowed from compression
--  Disable flush (flush gzipped content to client)
-
-Configuration
-=============
-
-Alternatively, a configuration can also be specified::
-
-    gzip.so <path-to-plugin>/sample.gzip.config
-
-After modifying plugin.config, restart traffic server (sudo traffic_ctl
-server restart) the configuration is also re-read when a management
-update is given (sudo traffic_ctl config reload)
-
-Options
-=======
-
-Flags and options are:
-
-``enabled``: (``true`` or ``false``) Enable or disable compression for a
-host.
-
-``remove-accept-encoding``: (``true`` or ``false``) Sets whether the
-plugin should hide the accept encoding from origin servers:
-
--  To ease the load on the origins.
--  For when the proxy parses responses, and the resulting
-   compression/decompression is wasteful.
-
-``cache``: (``true`` or ``false``) When set, the plugin stores the
-uncompressed and compressed response as alternates.
-
-``compressible-content-type``: Wildcard pattern for matching
-compressible content types.
-
-``disallow``: Wildcard pattern for disabling compression on urls.
-
-``flush``: (``true`` or ``false``) Enable or disable flushing of gzipped content.
-
-Options can be set globally or on a per-site basis, as such::
-
-    # Set some global options first
-    cache true
-    enabled true
-    remove-accept-encoding false
-    compressible-content-type text/*
-    flush false
-
-    # Now set a configuration for www.example.com
-    [www.example.com]
-    cache false
-    remove-accept-encoding true
-    disallow /notthis/*.js
-    flush true
-
-See example.gzip.config for example configurations.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/header_rewrite.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/header_rewrite.en.rst b/doc/reference/plugins/header_rewrite.en.rst
deleted file mode 100644
index 27cc269..0000000
--- a/doc/reference/plugins/header_rewrite.en.rst
+++ /dev/null
@@ -1,245 +0,0 @@
-.. _header-rewrite-plugin:
-
-Header Rewrite Plugin
-*********************
-
-.. 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.
-
-
-This is a plugin for Apache Traffic Server that allows you to
-modify various headers based on defined rules (operations) on a request or
-response.
-
-Using the plugin
-----------------
-
-This plugin can be used as both a global plugin, enabled in plugin.config::
-
-  header_rewrite.so config_file_1.conf config_file_2.conf ...
-
-These are global rules, which would apply to all requests. Another option is
-to use per remap rules in remap.config::
-
-  map http://a http://b @plugin=header_rewrite.so @pparam=rules1.conf ...
-
-In the second example, hooks which are not to be executed during the remap
-phase (the default) causes a transaction hook to be instantiated and used
-at a later time. This allows you to setup e.g. a rule that gets executed
-during the origin response header parsing, using READ_RESPONSE_HDR_HOOK.
-Note that the remap mode of the plugin can only execute rules on hooks that
-occur at remap phase or later (e.g. SEND_REQUEST_HDR_HOOK, READ_RESPONSE_HDR_HOOK etc),
-
-Configuration filenames without an absolute path are searched for in the
-default configuration directory. This is typically where your main
-configuration files are, e.g. ``/usr/local/etc/trafficserver``.
-
-Operators
----------
-
-The following operators are available::
-
-  rm-header header-name                      [operator_flags]
-  add-header header <value>                  [operator_flags]
-  set-header header <value>                  [operator_flags]
-  set-status <status-code>                   [operator_flags]
-  set-destination [qual] <value>             [operator_flags]
-  set-redirect <status-code> <destination>   [operator_flags]
-  set-timeout-out <value>                    [operator_flags]
-  set-status-reason <value>                  [operator_flags]
-  set-config overridable-config <value>      [operator_flags]
-  set-conn-dscp <value>                      [operator_flags]
-  counter counter-name                       [operator_flags]
-  no-op                                      [operator_flags]
-
-
-Where qual is one of the support URL qualifiers::
-
-  HOST
-  PORT
-  PATH
-  QUERY
-  SCHEME
-  URL
-
-For example (as a remap rule)::
-
-  cond %{HEADER:X-Mobile} = "foo"
-  set-destination HOST foo.mobile.bar.com [L]
-
-Operator flags
---------------
-
-The operator flags are optional, and must not contain whitespaces inside
-the brackets. Two flags are available:
-
-  [L]   Last rule, do not continue
-  [QSA] Append query string
-
-Variable expansion
-------------------
-Only limited variable expansion is supported in add-header. Supported
-substitutions include::
-
-  %<proto>      Protocol
-  %<port>       Port
-  %<chi>        Client IP
-  %<cqhl>       Client request length
-  %<cqhm>       Client HTTP method
-  %<cquup>      Client unmapped URI
-
-Conditions
-----------
-The conditions are used as qualifiers: The operators specified will
-only be evaluated if the condition(s) are met::
-
-  cond %{STATUS} operand                        [condition_flags]
-  cond %{RANDOM:nn} operand                     [condition_flags]
-  cond %{ACCESS:file}                           [condition_flags]
-  cond %{TRUE}                                  [condition_flags]
-  cond %{FALSE}                                 [condition_flags]
-  cond %{HEADER:header-name} operand            [condition_flags]
-  cond %{COOKIE:cookie-name} operand            [condition_flags]
-  cond %{CLIENT-HEADER:header-name} operand     [condition_flags]
-  cond %{PROTOCOL} operand                      [condition_flags]
-  cond %{PATH} operand                          [condition_flags]
-  cond %{QUERY} operand                         [condition_flags]
-  cond %{INTERNAL-TRANSACTION}                  [condition_flags]
-  cond %{CLIENT-IP}                             [condition_flags]
-  cond %{INCOMING-PORT}                         [condition_flags]
-  cond %{METHOD}                                [condition_flags]
-  cond %{CLIENT-URL:option-name}                [condition_flags]
-  cond %{URL:option-name}                       [condition_flags]
-  cond %{FROM-URL:option-name}                  [condition_flags]
-  cond %{TO-URL:option-name}                    [condition_flags]
-  cond %{TXN-COUNT}                             [condition_flags]
-
-The difference between HEADER and CLIENT-HEADER is that HEADER adapts to the
-hook it's running in, whereas CLIENT-HEADER always applies to the client
-request header. The %{TRUE} condition is also the default condition if no
-other conditions are specified.
-
-These conditions have to be first in a ruleset, and you can only have one in
-each rule. This implies that a new hook condition starts a new rule as well.::
-
-  cond %{READ_RESPONSE_HDR_HOOK}   (this is the default hook for global rules)
-  cond %{READ_REQUEST_HDR_HOOK}
-  cond %{READ_REQUEST_PRE_REMAP_HOOK}
-  cond %{SEND_REQUEST_HDR_HOOK}
-  cond %{SEND_RESPONSE_HDR_HOOK}
-
-For remap.config plugin instanations, the default hook is named
-REMAP_PSEUDO_HOOK. This can be useful if you are mixing other hooks in a
-configuration, but being the default it is also optional. This hook is
-executed directly as part of the remapping phase.
-
-Note that for configurations that are global, i.e. setup via
-``plugin.config``, the default hook is READ_RESPONSE_HDR_HOOK.
-
-CLIENT-URL, URL, URL-FROM, and URL-TO
--------------------------------------
-URL adapts to the hook it's running in and CLIENT-URL will always give you
-the client URL.  FROM-URL and TO-URL are from the remap rule that matched and
-can only be used if the plugin is a being run as a remap plugin.  An option
-is required to match that section of the URL.
-
-Supported Option Names:
-   HOST
-
-Example:
-   cond %{URL:HOST} =www.example.com
-
----------------
-Condition flags
----------------
-
-The condition flags are optional, and you can combine more than one into
-a comma-separated list of flags. Note that whitespaces are not allowed inside
-the brackets::
-
-  [NC]  Not case sensitive condition (when applicable) [NOT IMPLEMENTED!]
-  [AND] AND with next condition (default)
-  [OR]  OR with next condition
-  [NOT] Invert this condition
-
-Operands to conditions
-----------------------
-::
-
-  /string/  # regular expression
-  <string   # lexically lower
-  >string   # lexically greater
-  =string   # lexically equal
-
-The absence of a "matcher" means value exists.
-
-Values
-------
-Setting e.g. a header with a value can take the following formats:
-
-- Any of the cond definitions, that extracts a value from the request
-- $N 0 <= N <= 9, as grouped in a regular expression
-- string (which can contain the above)
-- null
-
-Examples
---------
-::
-
-  cond %{HEADER:X-Y-Foobar}
-  cond %{COOKIE:X-DC}  =DC1
-  add-header X-Y-Fiefum %{HEADER:X-Y-Foobar}
-  add-header X-Forwarded-For %<chi>
-  rm-header X-Y-Foobar
-  rm-header Set-Cookie
-  counter plugin.header_rewrite.x-y-foobar-dc1
-  cond %{HEADER:X-Y-Foobar} "Some string" [AND,NC]
-
-
-.. note:: Notes about header conditionals
-
-  In HTTP multiple headers can be consolidated into a single comma separated string.
-  To avoid complex markup within header-rewrite all header conditionals are
-  evaluated against all values of the header normalized into a single comma separated string.
-  Some examples:
-
-  Conditions::
-
-     # rule 1
-    cond %{HEADER:foo} /bar/
-
-     # rule 2
-    cond %{HEADER:foo} =bar
-
-  Examples::
-
-    # matches 1 and 2
-    foo: bar
-
-    # matches 1
-    foo: bar
-    foo: baz
-
-    # matches 1
-    foo: baz
-    foo: bar
-
-    # matches 1
-    foo: bar,baz
-
-    # matches 1
-    foo: baz,bar

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/hipes.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/hipes.en.rst b/doc/reference/plugins/hipes.en.rst
deleted file mode 100644
index 6248a9c..0000000
--- a/doc/reference/plugins/hipes.en.rst
+++ /dev/null
@@ -1,126 +0,0 @@
-.. _hipes-plugin:
-
-HIPES plugin
-************
-
-.. 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.
-
-
-This is a remap plugin used in the HIPES system.
-
-Configuration
-=============
-
-``urlp:<name>``
-    Default: ``url``
-    Name of the query parameter for the service URL
-
-``path:<path>``
-    Default: ``/``
-    Path to use for the service URL
-
-``ssl``
-    Default: ``no``
-    Use SSL when connecting to the service
-
-``service``
-    Service server, ``host[:port]``
-
-``server``
-    Default: ``hipes.yimg.com``
-    Name of HIPES server, ``host[:port]``
-
-``active_timeout``
-    The active connection timeout in ms
-
-``no_activity_timeout``
-    The no activity timeout in ms
-
-``connect_timeout``
-    The connect timeout in ms
-
-``dns_timeout``
-    The DNS timeout
-
-The timeout options override the server defaults (from
-```records.config``), and
-only apply to the connection to the specific "service" host.
-
-Notes on HIPES
-==============
-
-HTTP Pipes (aka HIPES and pronounced "Hippies") allows data services to be pipelined together, as illustrated by the
-example below. 
-
-Example
-=======
-1. ATS is run on port 80 and apache HTTP web server is run on port 8080 on localhost (127.0.0.1)
-
-2. The HIPES plugin is used in ``remap.config`` ::
-
-    map http://127.0.0.1/svc_case http://nosuchhost @plugin=hipes.so @pparam=service:127.0.0.1:8080 @pparam=path:svc_case.php @pparam=server:127.0.0.1
-    map http://127.0.0.1/svc_reverse http://nosuchhost @plugin=hipes.so @pparam=service:127.0.0.1:8080 @pparam=path:svc_reverse.php @pparam=server:127.0.0.1 
-    map http://127.0.0.1/test.txt http://127.0.0.1:8080/test.txt
-
-3. The plugin remaps the incoming URL such as :: 
-   
-    http://127.0.0.1/svc_reverse/svc_case;case=u/test.txt  
-
-to the following ::
- 
-    http://127.0.0.1:8080/svc_reverse?url=http%3A%2F%2F127.0.0.1%2Fsvc_case%3Bcase%3Du%2Ftest.txt
-
-4. The service ``svc_reverse.php`` fetches the ``url`` from the ATS again and the plugin remaps the URL ::
-
-    http://127.0.0.1/svc_case;case=u/test.txt
-
-to this URL :: 
-
-    http://127.0.0.1:8080/svc_case.php?case=u&url=http%3A%2F%2F127.0.0.1%2Ftest.txt
-
-5. In this example, the service ``svc_case.php`` fetches and transforms the response of ``http://127.0.0.1/test.txt``
-(which ATS proxies the request to a local file) to upper case. And subsequently the service ``svc_reverse.php`` receives
-the response and reverse the order before the response is sent back to the client by ATS. 
-
-Notes on reducing traffic 
-=========================
-
-There can be significant overhead using HIPES because the data can traverse through ATS many times. Caching can be
-important to reduce traffic to services/through ATS and can be achieved via a proper ``Cache-Control`` header returned
-by the services. Another way to reduce traffic through ATS is to have ATS to return 302 redirects to url for the
-requests made by service, instead of proxying the requests to that url. However, the service must then be able to follow
-the redirect. The down side is that we cannot use ATS to cache intermediate results. Below is an example of using
-redirect.  
-
-Modification to above example to reduce traffic using redirect
-==============================================================
-
-1. The service ``svc_reverse.php`` is modified to add a header of ``X-HIPES-Redirect: 2`` to the request made against
-``url``. 
-
-2. HIPES plugin will instruct ATS to return a redirect response to this url ::
-
-    http://127.0.0.1:8080/svc_case.php?case=u&url=http%3A%2F%2F127.0.0.1%2Ftest.txt
-
-for the following request ::
-
-    http://127.0.0.1/svc_case;case=u/test.txt
-
-3.  The service ``svc_reverse.php`` is also modified to follow the redirect. Thus the response of the service of
-``svc_case.php`` will not pass through ATS and will pass to ``svc_reverse.php`` service instead.  
-

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/index.en.rst b/doc/reference/plugins/index.en.rst
deleted file mode 100644
index 63c718f..0000000
--- a/doc/reference/plugins/index.en.rst
+++ /dev/null
@@ -1,84 +0,0 @@
-Plugin Reference
-****************
-
-.. 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.
-
-Overview
-========
-
-One of the key features of Apache Traffic Server is modularity.
-Features that aren't needed in the core simply aren't there. This
-is a good thing, because it guarantees that our core can remain
-fast by concentrating on the things that we always provide: Caching
-and proxying.
-
-All other things can be moved into plugins, by opening up a consistent
-C API, everyone can implement their own functionality, without
-having to touch the core.
-
-Stable plugins
-==============
-
-Plugins that are considered stable are installed by default in
-Apache Traffic Server releases.
-
-.. toctree::
-  :maxdepth: 1
-
-  CacheURL Plugin: allows you to change the key that is used for caching a request by using any portion of the url via regex <cacheurl.en>
-  conf_remap Plugin: allows you to override configuration directives dependent on actual remapping rules <conf_remap.en>
-  gzip / deflate Plugin: gzips or deflates responses <gzip.en>
-  Header Rewrite Plugin: allows you to modify various headers based on defined rules (operations) on a request or response <header_rewrite.en>
-  Regex Remap Plugin: allows you to configure mapping rules based on regular expressions <regex_remap.en>
-  Stats over HTTP Plugin: implements an HTTP interface to all Traffic Server statistics <stats_over_http.en>
-  TCPInfo Plugin: logs TCP metrics at various points in the HTTP processing pipeline <tcpinfo.en>
-
-Experimental plugins
-====================
-
-Plugins that are considered experimental are located in the
-`plugins/experimental <https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;a=tree;f=plugins/experimental;hb=HEAD>`_
-directory of the Apache Traffic Server source tree. Experimental plugins can be compiled by passing the
-`--enable-experimental-plugins` option to `configure`::
-
-    $ autoconf -i
-    $ ./configure --enable-experimental-plugins
-    $ make
-
-.. toctree::
-  :maxdepth: 1
-
-  AuthProxy Plugin: delegates the authorization decision of a request to an external HTTP service <authproxy.en>
-  Background Fetch Plugin: allows you to proactively fetch content from Origin in a way that it will fill the object into cache <background_fetch.en>
-  Balancer Plugin: balances requests across multiple origin servers <balancer.en>
-  Buffer Upload Plugin: buffers POST data before connecting to the Origin server <buffer_upload.en>
-  Cache Promotion Plugin: provides additional control over when an object should be allowed into the cache <cache_promote.en>
-  Combohandler Plugin: provides an intelligent way to combine multiple URLs into a single URL, and have Apache Traffic Server combine the components into one response <combo_handler.en>
-  Epic Plugin: emits Traffic Server metrics in a format that is consumed tby the Epic Network Monitoring System <epic.en>
-  ESI Plugin: implements the ESI specification <esi.en>
-  Generator Plugin: generate arbitrary response data <generator.en>
-  GeoIP ACLs Plugin: denying (or allowing) requests based on the source IP geo-location <geoip_acl.en>
-  hipes.en
-  Metalink Plugin: implements the Metalink download description format in order to try not to download the same file twice. <metalink.en>
-  MySQL Remap Plugin: allows dynamic “remaps” from a database <mysql_remap.en>
-  AWS S3 Authentication plugin: provides support for the Amazon S3 authentication features <s3_auth.en>
-  SSL Headers: Populate request headers with SSL session information <sslheaders.en>
-  stale_while_revalidate.en
-  ts-lua Plugin: allows plugins to be written in Lua instead of C code <ts_lua.en>
-  XDebug Plugin: allows HTTP clients to debug the operation of the Traffic Server cache using the X-Debug header <xdebug.en>
-  MP4 Plugin: mp4 streaming media <mp4.en>

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/metalink.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/metalink.en.rst b/doc/reference/plugins/metalink.en.rst
deleted file mode 100644
index b7de205..0000000
--- a/doc/reference/plugins/metalink.en.rst
+++ /dev/null
@@ -1,123 +0,0 @@
-.. 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.
-
-.. _metalink-plugin:
-
-
-Metalink Plugin
-===============
-
-The `Metalink` plugin implements the Metalink_ download description
-format in order to try not to download the same file twice.  This
-improves cache efficiency and speeds up users' downloads.
-
-It takes standard headers and knowledge about objects in the cache and
-potentially rewrites those headers so that a client will use a URL
-that's already cached instead of one that isn't.  The headers are
-specified in RFC 6249 (Metalink/HTTP: Mirrors and Hashes) and RFC 3230
-(Instance Digests in HTTP) and are sent by various download
-redirectors or content distribution networks.
-
-A lot of download sites distribute the same files from many different
-mirrors and users don't know which mirrors are already cached.  These
-sites often present users with a simple download button, but the
-button doesn't predictably access the same mirror, or a mirror that's
-already cached.  To users it seems like the download works sometimes
-(takes seconds) and not others (takes hours), which is frustrating.
-
-An extreme example of this happens when users share a limited,
-possibly unreliable internet connection, as is common in parts of
-Africa for example.
-
-
-How it Works
-------------
-
-When the plugin sees a response with a :mailheader:`Location: ...`
-header and a :mailheader:`Digest: SHA-256=...` header, it checks if
-the URL in the :mailheader:`Location` header is already cached.  If it
-isn't, then it tries to find a URL that is cached to use instead.  It
-looks in the cache for some object that matches the digest in the
-:mailheader:`Digest` header and if it succeeds, then it rewites the
-:mailheader:`Location` header with that object's URL.
-
-This way a client should get sent to a URL that's already cached and
-won't download the file again.
-
-
-Installation
-------------
-
-The `Metalink` plugin is a :term:`global plugin`.  Enable it by adding
-``metalink.so`` to your :file:`plugin.config` file.  There are no
-options.
-
-
-Implementation Status
----------------------
-
-The plugin implements the :c:data:`TS_HTTP_SEND_RESPONSE_HDR_HOOK`
-hook to check and potentially rewrite the :mailheader:`Location` and
-:mailheader:`Digest` headers after responses are cached.  It doesn't
-do it before they're cached because the contents of the cache can
-change after responses are cached.  It uses :c:func:`TSCacheRead` to
-check if the URL in the :mailheader:`Location` header is already
-cached.  In future, the plugin should also check if the URL is fresh
-or not.
-
-The plugin implements the :c:data:`TS_HTTP_READ_RESPONSE_HDR_HOOK`
-hook and :doc:`a null transformation <../../sdk/http-transformation-plugin/sample-null-transformation-plugin.en>` 
-to compute the SHA-256 digest for
-content as it's added to the cache.  It uses SHA256_Init(),
-SHA256_Update(), and SHA256_Final() from OpenSSL to compute the
-digest, then it uses :c:func:`TSCacheWrite` to associate the digest
-with the request URL.  This adds a new cache object where the key is
-the digest and the object is the request URL.
-
-To check if the cache already contains content that matches a digest,
-the plugin must call :c:func:`TSCacheRead` with the digest as the key,
-read the URL stored in the resultant object, and then call
-:c:func:`TSCacheRead` again with this URL as the key.  This is
-probably inefficient and should be improved.
-
-An early version of the plugin scanned :mailheader:`Link: <...>;
-rel=duplicate` headers.  If the URL in the :mailheader:`Location: ...`
-header wasn't already cached, it scanned :mailheader:`Link: <...>;
-rel=duplicate` headers for a URL that was.  The :mailheader:`Digest:
-SHA-256=...` header is superior because it will find content that
-already exists in the cache in every case that a :mailheader:`Link:
-<...>; rel=duplicate` header would, plus in cases where the URL is not
-listed among the :mailheader:`Link: <...>; rel=duplicate` headers,
-maybe because the content was downloaded from a URL not participating
-in the content distribution network, or maybe because there are too
-many mirrors to list in :mailheader:`Link: <...>; rel=duplicate`
-headers.
-
-The :mailheader:`Digest: SHA-256=...` header is also more efficient
-than :mailheader:`Link: <...>; rel=duplicate` headers because it
-involves a constant number of cache lookups.  RFC 6249 requires a
-:mailheader:`Digest: SHA-256=...` header or :mailheader:`Link: <...>;
-rel=duplicate` headers MUST be ignored:
-
-   If Instance Digests are not provided by the Metalink servers, the
-   :mailheader:`Link` header fields pertaining to this specification
-   MUST be ignored.
-
-   Metalinks contain whole file hashes as described in Section 6, and
-   MUST include SHA-256, as specified in [FIPS-180-3].
-
-
-.. _Metalink:    http://en.wikipedia.org/wiki/Metalink

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/mysql_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/mysql_remap.en.rst b/doc/reference/plugins/mysql_remap.en.rst
deleted file mode 100644
index 2bb3b00..0000000
--- a/doc/reference/plugins/mysql_remap.en.rst
+++ /dev/null
@@ -1,85 +0,0 @@
-.. _mysql-remap-plugin:
-
-MySQL Remap Plugin
-******************
-
-.. 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.
-
-
-This is a basic plugin for doing dynamic "remaps" from a database. It
-essentially rewrites the incoming request's Host header / origin server
-connection to one retrieved from a database.
-
-The generic proxying setup is the following::
-
-    UA ----> Traffic Server ----> Origin Server
-
-Without the plugin a request like::
-
-    GET /path/to/something HTTP/1.1
-    Host: original.host.com
-
-Ends up requesting ``http://original.host.com/path/to/something``
-
-With this plugin enabled, you can easily change that to anywhere you
-desire. Imagine the many possibilities....
-
-We have benchmarked the plugin with ab at about 9200 requests/sec (1.7k
-object) on a commodity hardware with a local setup of both, MySQL and
-Traffic Server local. Real performance is likely to be substantially
-higher, up to the MySQL's max queries / second.
-
-Installation
-============
-
-This plugin is only built if the configure option ::
-
-    --enable-experimental-plugins
-
-is given at build time.
-
-Configuration
-=============
-
-Import the default schema to a database you create::
-
-    mysql -u root -p -e "CREATE DATABASE mysql_remap;"   # create a new database
-    mysql -u root -p mysql_remap < schema/import.sql     # import the provided schema
-
-insert some interesting values in mysql_remap.hostname &
-mysql_remap.map
-
-Traffic Server plugin configuration is done inside a global
-configuration file: ``/etc/trafficserver/plugin.config``::
-
-    mysql_remap.so /etc/trafficserver/mysql_remap.ini
-
-The INI file should contain the following values::
-
-    [mysql_remap]
-    mysql_host     = localhost   #default
-    mysql_port     = 3306        #default
-    mysql_username = remap_user
-    mysql_password = 
-    mysql_database = mysql_remap #default
-
-To debug errors, start trafficserver manually using::
-
-    traffic_server -T "mysql_remap"
-
-And resolve any errors or warnings displayed.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/regex_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/regex_remap.en.rst b/doc/reference/plugins/regex_remap.en.rst
deleted file mode 100644
index 5a11047..0000000
--- a/doc/reference/plugins/regex_remap.en.rst
+++ /dev/null
@@ -1,142 +0,0 @@
-.. _regex-remap-plugin:
-
-Regex Remap Plugin
-******************
-
-.. 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.
-
-
-This allows you to configure mapping rules based on regular expressions.
-This is similar to what you can accomplish using mod_rewrite in Apache
-httpd, but obviously not as flexible or sophisticated (yet).
-
-To use this plugin, configure a remap.config rule like ::
-
-    map http://a.com http://b.com @plugin=regex_remap.so @pparam=maps.reg
-
-The file name parameter is always required. Unless an absolute path
-is specified, the file name is assumed to be a path relative to the
-Traffic Server configuration directory.
-
-The regular expressions listed in the configuration file are evaluated
-sequentially. When a regular expression is positively matched against
-a request URL, evaluation is stopped and the rewrite rule is applied.
-If none of the regular expressions are a match, the default destination
-URL is applied (``http://b.com`` in the example above).
-
-An optional argument (``@pparam``) with the string "``profile``\ " will
-enable profiling of this regex remap rule, e.g. ::
-
-    ... @pparam=maps.reg @pparam=profile
-
-Profiling is very low overhead, and the information is dumped to
-``traffic.out``, located in the log directory. This information is
-useful to optimize the order of your regular expression, such that the
-most common matches appears early in the file. In order to force a
-profile dump, you can do ::
-
-    $ sudo touch remap.config
-    $ sudo traffic_ctl config reload
-
-By default, only the path and query string of the URL are provided for
-the regular expressions to match. The following optional parameters can
-be used to modify the plugin instance behavior ::
-
-    @pparam=[no-]method              [default: off]
-    @pparam=[no-]query-string        [default: on]
-    @pparam=[no-]matrix-parameters   [default: off]
-
-If you wish to match on the HTTP method used (e.g. "``GET``\ "),
-you must use the option ``@pparam=method``. e.g. ::
-
-    ... @pparam=maps.reg @pparam=method
-
-With this enabled, the string that you will need to match will look
-like ::
-
-    GET/path?query=bar
-
-The methods are always all upper-case, and always followed by one single
-space. There is no space between the method and the rest of the URL (or
-URI path).
-
-By default, the query string is part of the string that is matched
-again, to turn this off use the option 'no-query-string', e.g. ::
-
-    ... @pparam=maps.reg @pparam=no-query-string
-
-Finally, you can also include the matrix parameters in the string, using
-the option 'matrix-parameters', e.g. ::
-
-    ... @pparam=maps.reg @pparam=matrix-parameters
-
-A typical regex would look like ::
-
-    ^/(ogre.*)/more     http://www.ogre.com/$h/$0/$1
-
-The regular expression must not contain any white spaces!
-
-When the regular expression is matched, only the URL path + query string
-is matched (without any of the optional configuration options). The path
-will always start with a "/". Various substitution strings are allowed
-on the right hand side during evaluation ::
-
-    $0     - The entire matched string
-    $1-9   - Regular expression groups ($1 first group etc.)
-    $h     - The original host header from the request
-    $f     - The host as used in the "from" portion of the remap rule
-    $t     - The host as used in the "to" portion of the remap rule
-    $p     - The original port number
-    $s     - The scheme (e.g. http) of the request
-    $P     - The entire path of the request
-    $q     - The query part of the request
-    $r     - The path parameters of the request (not implemented yet)
-    $c     - The cookie string from the request
-    $i     - The client IP for this request
-
-.. note::
-
-    The ``$0`` substitution expands to the characters that were
-    matched by the regular expression, not to the entire string that
-    the regular expression was matched against.
-
-You can also provide options, similar to how you configure your
-remap.config. The following options are available ::
-
-    @status=<nnn>               - Force the response code to <nnn>
-    @active_timeout=<nnn>       - Active timeout (in ms)
-    @no_activity_timeout=<nnn>  - No activity timeout (in ms)
-    @connect_timeout=<nnn>      - Connect timeouts (in ms)
-    @dns_timeout=<nnn>          - Connect timeouts (in ms)
-
-    @overridable-config=<value> - see :ref:`ts-overridable-config`
-
-    @caseless                   - Make regular expressions case insensitive
-    @lowercase_substitutions    - Turn on (enable) lower case substitutions
-
-
-This can be useful to force a particular response for some URLs, e.g. ::
-
-    ^/(ogre.*)/bad      http://www.examle.com/  @status=404
-
-Or, to force a 302 redirect ::
-
-    ^/oldurl/(.*)$      http://news.example.com/new/$1 @status=302
-
-Setting the status to 301 or 302 will force the new URL to be used
-as a redirect (Location:).

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/s3_auth.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/s3_auth.en.rst b/doc/reference/plugins/s3_auth.en.rst
deleted file mode 100644
index 38861d5..0000000
--- a/doc/reference/plugins/s3_auth.en.rst
+++ /dev/null
@@ -1,84 +0,0 @@
-.. _s3-auth-plugin:
-
-AWS S3 Authentication plugin
-****************************
-
-.. 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.
-
-
-This is a plugin for Apache Traffic Server that provides support for the
-``Amazon S3`` authentication features. This is useful if you for example want
-to use ``S3`` as your origin server, yet want to avoid direct user access to
-the content.
-
-Using the plugin
-----------------
-
-There are three configuration options for this plugin::
-
-    --access_key    <key>
-    --secret_key    <key>
-    --virtual_host
-    --config        <config file>
-
-
-Using the first two in a remap rule would be e.g.::
-
-   ...  @plugin=s3_auth @pparam=--access_key @pparam=my-key \
-                        @pparam=--secret_key @pparam=my-secret \
-			@pparam=--virtual_host
-
-
-Alternatively, you can store the access key and secret in an external
-configuration file, and point the remap rule(s) to it:
-
-   ...  @plugin=s3_auth @pparam=--config @pparam=s3.config
-
-
-Where s3.config would look like::
-
-    # AWS S3 authentication
-        access_key=my-key
-        secret_key=my-secret
-        virtual_host=yes
-
-
-For more details on the S3 auth, see::
-
-  http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
-
-
-ToDo
-----
-
-This is a pretty barebone start for the S3 services, it is missing a number of features:
-
-- It does not do UTF8 encoding (as required)
-
-- It only implements the v2 authentication mechanism. For details on v4, see
-
-  http://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
-
-- It does not deal with canonicalization of AMZ headers.
-
-- It does not handle POST requests (but do we need to ?)
-
-- It does not incorporate query parameters.
-
-
-Contributions to any of these would be appreciated.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/sslheaders.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/sslheaders.en.rst b/doc/reference/plugins/sslheaders.en.rst
deleted file mode 100644
index bab09c2..0000000
--- a/doc/reference/plugins/sslheaders.en.rst
+++ /dev/null
@@ -1,91 +0,0 @@
-.. _sslheaders-plugin:
-
-SSLHeaders Plugin
-*****************
-
-.. 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.
-
-The ``sslheaders`` plugins injects SSL session information into
-HTTP request headers. It can operate as a global plugin or as a
-remap plugin.
-
-Plugin Options
---------------
-
-The following options may be specified when loading the plugin in
-:file:`plugin.config` or :file:`remap.config`:
-
---attach=WHICH  This option specifies which HTTP request the SSL headers are
-                attached to.
-
-                ``client`` causes the headers to be injected into
-                the client request. This is primarily useful if another plugin
-                should inspect then. ``server`` is the default and injects the
-                headers into the origin server request. ``both`` injects the
-                headers into both the client request and the origin server
-                request.
-
-A list of `KEY=VALUE` pairs follows any options. The `KEY` names the HTTP
-header to inject, and `VALUE` names the SSL session field.
-
-======================  ===============================================
-SSL session field       Description
-======================  ===============================================
-client.certificate      The client certificate in PEM format
-client.subject          The client certificate subject DN
-client.issuer           The client certificate issuer DN
-client.serial           The client certificate serial number in hexadecimal format
-client.signature        The client certificate signature in hexadecimal format
-client.notbefore        The client certificate validity start time
-client.notafter         The client certificate validity end time
-server.certificate      The server certificate in PEM format
-server.subject          The server certificate subject DN
-server.issuer           The server certificate issuer DN
-server.serial           The server certificate serial number in hexadecimal format
-server.signature        The server certificate signature in hexadecimal format
-server.notbefore        The server certificate validity start time
-server.notafter         The server certificate validity end time
-======================  ===============================================
-
-The `client.certificate` and `server.certificate` fields emit
-the corresponding certificate in PEM format, with newline characters
-replaced by spaces.
-
-If the ``sslheaders`` plugin activtes on non-SSL connections, it
-will delete all the configured HTTP header names so that malicious
-clients cannot inject misleading information. If any of the SSL
-fields expand to an empty string, those headers are also deleted.
-
-Examples:
----------
-
-In this example, the origin server is interested in the subject of
-the server certificate that was used to accept a client connetion.
-We can apply the ``sslheaders`` plugin to a generic remap rule to
-provide this information. The :file:`remap.config` configuration
-would be::
-
-  regex_map https://*.example.com/ http://origin.example.com/ \
-    @plugin=sslheaders.so @pparam=SSL-Server=server.subject
-
-In this example, we have set :ts:cv:`proxy.config.ssl.client.certification_level`
-to request SSL client certificates. We can then configure ``sslheaders``
-to populate the client certificate subject globally by adding it
-to :file:`plugin.config`::
-
-  sslheaders.so SSL-Client-ID=client.subject SSL-Client-NotBefore=client.notbefore SSL-Client-NotAfter-client.notafter

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/stale_while_revalidate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/stale_while_revalidate.en.rst b/doc/reference/plugins/stale_while_revalidate.en.rst
deleted file mode 100644
index 108cf38..0000000
--- a/doc/reference/plugins/stale_while_revalidate.en.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-.. _stale-while-revalidate-plugin:
-
-Stale While Revalidate Plugin (undocumented)
-********************************************
-
-.. 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.
-
-refresh content asynchronously while serving stale data

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/stats_over_http.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/stats_over_http.en.rst b/doc/reference/plugins/stats_over_http.en.rst
deleted file mode 100644
index 59ba7fc..0000000
--- a/doc/reference/plugins/stats_over_http.en.rst
+++ /dev/null
@@ -1,68 +0,0 @@
-.. _stats-over-http-plugin:
-
-Stats over HTTP Plugin
-**********************
-
-.. 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.
-
-
-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.
-
-To enable this plugin, add to the plugin.conf file::
-
-    stats_over_http.so
-
-
-After starting Traffic Server, the JSON metrics are now available on the
-default URL::
-
-    http://host:port/_stats
-
-where host and port is the hostname/IP and port number of the server.
-
-Plugin Options
---------------
-
-.. option:: --integer-counters
-
-This option causes the plugin to emit floating point and integral
-metric values as JSON numbers, rather then JSON strings. This can
-cause interoperability problems since integer metrics have a 64-bit
-unsigned range.
-
-.. option:: --wrap-counters
-
-This option wraps 64-bit unsigned values to the 64-bit signed range.
-This aids interoperability with Java, since prior to the Java SE 8
-release, Java did not have a 64-bit unsigned type.
-
-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.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/plugins/tcpinfo.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/tcpinfo.en.rst b/doc/reference/plugins/tcpinfo.en.rst
deleted file mode 100644
index 19db046..0000000
--- a/doc/reference/plugins/tcpinfo.en.rst
+++ /dev/null
@@ -1,123 +0,0 @@
-.. _tcpinfo-plugin:
-
-TCPInfo Plugin
-**************
-
-.. 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.
-
-This global plugin logs TCP metrics at various points in the HTTP
-processing pipeline. The TCP information is retrieved by the
-:manpage:`getsockopt(2)` function using the ``TCP_INFO`` option.
-This is only supported on systems that support the ``TCP_INFO``
-option, currently Linux and BSD.
-
-Plugin Options
---------------
-
-The following options may be specified in :file:`plugin.config`:
-
-.. NOTE: if the option name is not long enough, docutils will not
-   add the colspan attribute and the options table formatting will
-   be all messed up. Just a trap for young players.
-
---hooks=NAMELIST
-  This option specifies when TCP information should be logged. The
-  argument is a comma-separated list of the event names listed
-  below. TCP information will be sampled and logged each time the
-  specified set of events occurs.
-
-  ==============  ===============================================
-   Event Name     Triggered when
-  ==============  ===============================================
-  send_resp_hdr   The server begins sending an HTTP response.
-  ssn_close       The TCP connection closes.
-  ssn_start       A new TCP connection is accepted.
-  txn_close       A HTTP transaction is completed.
-  txn_start       A HTTP transaction is initiated.
-  ==============  ===============================================
-
---log-file=NAME
-  This specifies the base name of the file where TCP information
-  should be logged. If this option is not specified, the name
-  ``tcpinfo`` is used. Traffic Server will automatically append
-  the ``.log`` suffix.
-
---log-level=LEVEL
-  The log level can be either ``1`` to log only the round trip
-  time estimate, or ``2`` to log the complete set of TCP information.
-
-  The following fields are logged when the log level is ``1``:
-
-  ==========    ==================================================
-  Field Name    Description
-  ==========    ==================================================
-  timestamp     Event timestamp
-  event         Event name (one of the names listed above)
-  client        Client IP address
-  server        Server IP address
-  rtt           Estimated round trip time
-  ==========    ==================================================
-
-  The following fields are logged when the log level is ``2``:
-
-  ==============    ==================================================
-  Field Name        Description
-  ==============    ==================================================
-  timestamp         Event timestamp
-  event             Event name (one of the names listed above)
-  client            Client IP address
-  server            Server IP address
-  rtt               Estimated round trip time
-  rttvar
-  last_sent
-  last_recv
-  snd_cwnd
-  snd_ssthresh
-  rcv_ssthresh
-  unacked
-  sacked
-  lost
-  retrans
-  fackets
-  ==============    ==================================================
-
---sample-rate=COUNT
-  This is the number of times per 1000 requests that the data will
-  be logged.  A pseudo-random number generator is used to determine if a
-  request will be logged.  The default value is 1000 and this option is
-  not required to be in the configuration file.  To achieve a log rate
-  of 1% you would set this value to 10.
-
-Examples:
----------
-
-This example logs the simple TCP information to ``tcp-metrics.log``
-at the start of a TCP connection and once for each HTTP
-transaction thereafter::
-
-  tcpinfo.so --log-file=tcp-metrics --log-level=1 --hooks=ssn_start,txn_start
-
-The file ``tcp-metrics.log`` will contain the following log format::
-
-  timestamp event client server rtt
-  20140414.17h40m14s ssn_start 127.0.0.1 127.0.0.1 4000
-  20140414.17h40m14s txn_start 127.0.0.1 127.0.0.1 4000
-  20140414.17h40m16s ssn_start 127.0.0.1 127.0.0.1 4000
-  20140414.17h40m16s txn_start 127.0.0.1 127.0.0.1 4000
-  20140414.17h40m16s ssn_start 127.0.0.1 127.0.0.1 4000
-  20140414.17h40m16s txn_start 127.0.0.1 127.0.0.1 4000


Mime
View raw message