You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2013/12/10 20:26:20 UTC
[3/3] git commit: TS-2424: document diagnostic logging configuration
TS-2424: document diagnostic logging configuration
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/536fb8e0
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/536fb8e0
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/536fb8e0
Branch: refs/heads/master
Commit: 536fb8e018c5556e5e12ce42f4c5011b84fdcf2e
Parents: 4b94cdf
Author: James Peach <jp...@apache.org>
Authored: Tue Dec 10 11:21:42 2013 -0800
Committer: James Peach <jp...@apache.org>
Committed: Tue Dec 10 11:25:41 2013 -0800
----------------------------------------------------------------------
.../configuration/records.config.en.rst | 53 ++++++++++++++++----
.../unable-to-debug-tags.en.rst | 4 +-
2 files changed, 45 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/536fb8e0/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
index bbe1a4d..9d9cb39 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -1796,14 +1796,20 @@ server, refer to `logs_xml.config <logs_xml.config>`_.
Diagnostic Logging Configuration
================================
-.. ts:cv:: CONFIG proxy.config.diags.output.status STRING
-
-.. ts:cv:: CONFIG proxy.config.diags.output.warning STRING
-
-.. ts:cv:: CONFIG proxy.config.diags.output.emergency STRING
-
- control where Traffic Server should log diagnostic output. Messages at diagnostic level can be directed to any combination of diagnostic
- destinations. Valid diagnostic message destinations are:::
+.. ts:cv:: CONFIG proxy.config.diags.output.diag STRING E
+.. ts:cv:: CONFIG proxy.config.diags.output.debug STRING E
+.. ts:cv:: CONFIG proxy.config.diags.output.status STRING L
+.. ts:cv:: CONFIG proxy.config.diags.output.note STRING L
+.. ts:cv:: CONFIG proxy.config.diags.output.warning STRING L
+.. ts:cv:: CONFIG proxy.config.diags.output.error STRING SL
+.. ts:cv:: CONFIG proxy.config.diags.output.fatal STRING SL
+.. ts:cv:: CONFIG proxy.config.diags.output.alert STRING L
+.. ts:cv:: CONFIG proxy.config.diags.output.emergency STRING SL
+
+ The diagnosic output configuration variables control where Traffic
+ Server should log diagnostic output. Messages at each diagnostic level
+ can be directed to any combination of diagnostic destinations.
+ Valid diagnostic message destinations are:
* 'O' = Log to standard output
* 'E' = Log to standard error
@@ -1812,9 +1818,36 @@ Diagnostic Logging Configuration
.. topic:: Example
- To log debug diagnostics to both syslog and diags.log:::
+ To log debug diagnostics to both syslog and `diags.log`::
+
+ CONFIG proxy.config.diags.output.debug STRING SL
+
+.. ts:cv:: CONFIG proxy.config.diags.show_location INT 0
+
+ Annotates diagnostic messages with the source code location.
+
+.. ts:cv:: CONFIG proxy.config.diags.debug.enabled INT 0
+
+ Enables logging for diagnostic messages whose log level is `diag` or `debug`.
+
+.. ts:cv:: CONFIG proxy.config.diags.debug.tags STRING NULL
+
+ Each Traffic Server `diag` and `debug` level message is annotated
+ with a subsytem tag. This configuration contains a regular
+ expression that filters the messages based on the tag. Some
+ commonly used debug tags are::
+
+============ =====================================================
+Tag Subsytem usage
+============ =====================================================
+ssl TLS termination and certificate processing
+dns DNS query resolution
+http_hdrs Logs the headers for HTTP requests and responses
+============ =====================================================
- proxy.config.diags.output.debug STRING SL
+ Traffic Server plugins will typically log debug messages using
+ the :func:`TSDebug` API, passing the plugin name as the debug
+ tag.
Reverse Proxy
=============
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/536fb8e0/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst b/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst
index 5ed5877..745712a 100644
--- a/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst
+++ b/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst
@@ -43,8 +43,8 @@ Set the following variables in :file:`records.config` (in the Traffic Server
::
:::text
- proxy.config.diags.debug.enabled INT 1
- proxy.config.diags.debug.tags STRING debug-tag-name
+ CONFIG proxy.config.diags.debug.enabled INT 1
+ CONFIG proxy.config.diags.debug.tags STRING debug-tag-name
In this case, debug output goes to ``traffic.out``.