trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [trafficserver] branch 8.0.x updated: Documentation for traffic dump
Date Wed, 10 Oct 2018 22:31:13 GMT
This is an automated email from the ASF dual-hosted git repository.

bcall pushed a commit to branch 8.0.x
in repository

The following commit(s) were added to refs/heads/8.0.x by this push:
     new ced3295  Documentation for traffic dump
ced3295 is described below

commit ced32959306247cea96b30ffd30deba6011c4692
Author: dyrock <>
AuthorDate: Fri Sep 7 16:31:57 2018 -0500

    Documentation for traffic dump
    (cherry picked from commit 6533f04527084c2061857aa2a9449c5907cb9d00)
 doc/admin-guide/plugins/index.en.rst        |  4 +++
 doc/admin-guide/plugins/traffic_dump.en.rst | 55 +++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)

diff --git a/doc/admin-guide/plugins/index.en.rst b/doc/admin-guide/plugins/index.en.rst
index 0b097f3..4391308 100644
--- a/doc/admin-guide/plugins/index.en.rst
+++ b/doc/admin-guide/plugins/index.en.rst
@@ -159,6 +159,7 @@ directory of the |TS| source tree. Experimental plugins can be compiled
by passi
    SSL Headers <sslheaders.en>
    Stale While Revalidate <stale_while_revalidate.en>
    System Statistics <system_stats.en>
+   Traffic Dump <traffic_dump.en>
    WebP Transform <webp_transform.en>
    Prefetch <prefetch.en>
@@ -220,5 +221,8 @@ directory of the |TS| source tree. Experimental plugins can be compiled
by passi
 :doc:`System Stats <system_stats.en>`
     Inserts system statistics in to the stats list
+:doc:`Traffic Dump <traffic_dump.en>`
+   Dumps traffic data into a JSON format file which can be used to replay traffic.
 :doc:`WebP Transform <webp_transform.en>`
    Converts jpeg and png images to webp format.
diff --git a/doc/admin-guide/plugins/traffic_dump.en.rst b/doc/admin-guide/plugins/traffic_dump.en.rst
new file mode 100644
index 0000000..114edd2
--- /dev/null
+++ b/doc/admin-guide/plugins/traffic_dump.en.rst
@@ -0,0 +1,55 @@
+.. 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
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+.. include:: ../../common.defs
+.. _admin-plugins-access_control:
+Traffic Dump Plugin
+``Traffic Dump`` captures session traffic and writes to a replay file :ts:git:`tests/tools/traffic-replay/replay_schema.json`
for each captured session. It then can be used to replay traffic for testing purpose.
+Plugin Configuration
+.. program::
+* ``Traffic Dump`` is a global plugin and is configured via :file:`plugin.config`.
+   .. option:: --logdir <path_to_dump>
+   (`required`, default:empty/unused) - specifies the directory for writing all dump files.
If path is relative, it is relative to the Traffic Server directory. The plugin will use first
three characters of client ip to create subdirs in an attempt to spread dumps evenly and avoid
too many files in a single directory.
+   .. option:: --sample <N>
+   (`optional`, default:1000) - specifies the sampling ratio N. Traffic Dump will capture
every one out of N sessions. This ratio can also be changed via traffic_ctl without restarting
+* ``traffic_ctl`` command.
+   ``traffic_ctl plugin msg traffic_dump.sample N`` - changes the sampling ratio N as mentioned
+Replay Format
+This format contains traffic data including:
+* Each session and transactions in the session.
+* Timestamps.
+* The four headers (ua request, proxy request, origin server response, proxy response).
+* The protocol stack for the user agent.
+* The transaction count for the outbound session.
+* The content block sizes.
+* See schema here: :ts:git:`tests/tools/traffic-replay/replay_schema.json`

View raw message