[3/3] git commit: TS-2426: document the xdebug plugin

[jp...@apache.org]

TS-2426: document the xdebug plugin


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

Branch: refs/heads/master
Commit: 399e27cc14be15d20ac786860f40a031a9be38e3
Parents: 14667c6
Author: James Peach <jp...@apache.org>
Authored: Sat Dec 7 20:29:42 2013 -0800
Committer: James Peach <jp...@apache.org>
Committed: Tue Dec 10 09:28:18 2013 -0800

----------------------------------------------------------------------
 doc/reference/plugins/index.en.rst  |  1 +
 doc/reference/plugins/xdebug.en.rst | 45 ++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/399e27cc/doc/reference/plugins/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/index.en.rst b/doc/reference/plugins/index.en.rst
index 4001acc..4b9307b 100644
--- a/doc/reference/plugins/index.en.rst
+++ b/doc/reference/plugins/index.en.rst
@@ -73,4 +73,5 @@ directory of the Apache Traffic Server source tree. Exmperimental plugins can be
   mysql_remap.en
   stale_while_revalidate.en
   ts_lua.en
+  xdebug.en
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/399e27cc/doc/reference/plugins/xdebug.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/xdebug.en.rst b/doc/reference/plugins/xdebug.en.rst
new file mode 100644
index 0000000..bf2ac13
--- /dev/null
+++ b/doc/reference/plugins/xdebug.en.rst
@@ -0,0 +1,45 @@
+XDebug 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 `XDebug` plugin allows HTTP clients to debug the operation of
+the Traffic Server cache using the ``X-Debug`` header. The plugin
+is triggered by the presence of the ``X-Debug`` header in the client
+request. The contents of this header should be the names of the
+debug headers that are desired in the response. The `XDebug` plugin
+will remove the ``X-Debug`` header from the client request and
+inject the desired headers into the client response.
+
+`XDebug` is a global plugin. It is installed by adding it to the
+:file:`plugin.config` file.
+
+Debugging Headers
+=================
+
+The `XDebug` plugin is able to generate the following debugging headers:
+
+Via
+    If the ``Via`` header is requested, the `XDebug` plugin sets the
+    :ts:cv:`proxy.config.http.insert_response_via_str` configuration variable
+    to ``3`` for the request.
+
+X-Cache-Key
+    The ``X-Cache-Key`` contains the URL that identifies the HTTP object in the
+    Traffic Server cache. This header is particularly useful if a custom cache
+    key is being used.