You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2013/12/08 01:01:56 UTC
[4/4] git commit: docs: Update troubleshooting section.
docs: Update troubleshooting section.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/5f687665
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/5f687665
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/5f687665
Branch: refs/heads/trunk
Commit: 5f687665adfc7e2533012289a1805928535ec154
Parents: 028b992
Author: Tomaz Muraus <to...@apache.org>
Authored: Sun Dec 8 00:55:13 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sun Dec 8 00:55:13 2013 +0100
----------------------------------------------------------------------
docs/troubleshooting.rst | 24 ++++++++++++++----------
1 file changed, 14 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/5f687665/docs/troubleshooting.rst
----------------------------------------------------------------------
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
index 64f3582..c100662 100644
--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@@ -13,27 +13,31 @@ Debugging
.. note::
- If you are sharing debug output on our IRC channel or issue tracker using
- Pastebin, Github Gists or a similar service, make sure to remove your
- credentials and any other data you consider private from the output.
+ If you are sharing debug output on any public medium such as our IRC
+ channel or an issue tracker using Pastebin, Github Gists or a similar
+ service, make sure to remove your credentials and any other data you
+ consider private from the output.
-Libcloud has a special debug mode which when enabled outputs all the outgoing
+Libcloud has a special debug mode which when enabled, logs all the outgoing
HTTP requests and all the incoming HTTP responses. Output also includes cURL
commands which can be used to re-produce the requests.
-When this mode is enabled and if ``paramiko`` library is installed (used for
-deployment), paramiko library log level is also set to ``DEBUG`` which helps
-with debugging the deployment issues.
+When this mode is enabled and ``paramiko`` library is installed (used for
+deployment), paramiko library log level is set to ``DEBUG`` which helps with
+debugging the deployment related issues.
+
+To make the debugging easier, Libcloud will also automatically decompress the
+response body (if compressed) before logging it.
To enable it, set ``LIBCLOUD_DEBUG`` environment variable and make it point
-to a file where the output should be saved.
+to a file where the debug output should be saved.
For example if you want the output to be logged to the standard error (on
-Unix) you can set it to ``/dev/stderr``:
+Linux) you can set it to ``/dev/stderr``:
.. sourcecode:: bash
- LIBCLOUD_DEBUG=/dev/stderr python my_script.py.
+ LIBCLOUD_DEBUG=/dev/stderr python my_script.py
Example output: