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 2011/11/02 02:03:11 UTC

svn commit: r1196418 - in /libcloud/site/trunk: content/docs/debugging.mdtext templates/blocks/menu_docs.html

Author: tomaz
Date: Wed Nov  2 01:03:11 2011
New Revision: 1196418

URL: http://svn.apache.org/viewvc?rev=1196418&view=rev
Log:
Add a section about debugging.

Added:
    libcloud/site/trunk/content/docs/debugging.mdtext
Modified:
    libcloud/site/trunk/templates/blocks/menu_docs.html

Added: libcloud/site/trunk/content/docs/debugging.mdtext
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/docs/debugging.mdtext?rev=1196418&view=auto
==============================================================================
--- libcloud/site/trunk/content/docs/debugging.mdtext (added)
+++ libcloud/site/trunk/content/docs/debugging.mdtext Wed Nov  2 01:03:11 2011
@@ -0,0 +1,37 @@
+title: Debugging
+
+## Debugging ##
+
+Libcloud has a special debug mode which when enabled outputs 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.
+
+To enable it, set `LIBCLOUD_DEBUG` environment variable and make it point to a
+file where the 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` - `LIBCLOUD_DEBUG=/dev/stderr python my_script.py`.
+
+Example output:
+
+    # -------- begin 4431824872 request ----------
+    curl -i -X GET -H 'Host: s3.amazonaws.com' -H 'X-LC-Request-ID: 4431824872' -H 'Content-Length: 0' -H 'User-Agent: libcloud/0.6.0-beta1 (Amazon S3 (standard))' 'https://s3.amazonaws.com:443/?AWSAccessKeyId=foo&Signature=bar'
+    # -------- begin 4431824872:4431825232 response ----------
+    HTTP/1.1 200 OK
+    X-Amz-Id-2: 1234
+    Server: AmazonS3
+    Transfer-Encoding: chunked
+    X-Amz-Request-Id: FFFFFFFFFF
+    Date: Tue, 01 Nov 2011 22:29:11 GMT
+    Content-Type: application/xml
+
+    171
+    <?xml version="1.0" encoding="UTF-8"?>
+    <ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Owner><ID>sada8932dsa8d30i</ID><DisplayName>kami</DisplayName></Owner><Buckets><Bucket><Name>test34324323</Name><CreationDate>2011-11-01T22:17:23.000Z</CreationDate></Bucket></Buckets></ListAllMyBucketsResult>
+    0
+
+    # -------- end 4431824872:4431825232 response ----------

Modified: libcloud/site/trunk/templates/blocks/menu_docs.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/templates/blocks/menu_docs.html?rev=1196418&r1=1196417&r2=1196418&view=diff
==============================================================================
--- libcloud/site/trunk/templates/blocks/menu_docs.html (original)
+++ libcloud/site/trunk/templates/blocks/menu_docs.html Wed Nov  2 01:03:11 2011
@@ -12,5 +12,11 @@
         <li class="title">Storage</li>
         <li class="title">Load Balancer</li>
     </ul>
+    <li>Other</li>
+    <ul>
+        <ul>
+            <li><a href="debugging.html">Debugging</a></li>
+        </ul>
+    </ul>
     <li><a href="/apidocs">Generated API docs</a></li>
 </ul>