summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAbhiraj Butala <abhiraj.butala@gmail.com>2014-05-08 21:28:24 -0700
committerAbhiraj Butala <abhiraj.butala@gmail.com>2014-05-08 21:28:24 -0700
commit41f63ea0083ba72f0d985e5f24c743cd2b5cbbe2 (patch)
treea2c1207cda0c3bf8c8af2fd2c9caca6ae3bd06e8 /docs
parent723a5c2165b8fcc21332e459a3def31b28f0994f (diff)
downloadkazoo-41f63ea0083ba72f0d985e5f24c743cd2b5cbbe2.tar.gz
Update basic_usage.rst
Added documentation for the optional logging setup needed for the clients.
Diffstat (limited to 'docs')
-rw-r--r--docs/basic_usage.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/basic_usage.rst b/docs/basic_usage.rst
index 4bb7413..43ce4c0 100644
--- a/docs/basic_usage.rst
+++ b/docs/basic_usage.rst
@@ -4,6 +4,7 @@
Basic Usage
===========
+
Connection Handling
===================
@@ -29,6 +30,26 @@ instructed to drop a connection by calling `stop`:
zk.stop()
+
+Logging Setup
+-------------
+
+If logging is not setup for your application, you can get following error:
+
+.. code-block:: python
+
+ No handlers could be found for logger "kazoo.client"
+
+To avoid this issue you can do the following at the very minimum:
+
+.. code-block:: python
+
+ import logging
+ logging.basicConfig()
+
+More details about logging setup can be found
+`here <https://docs.python.org/2/howto/logging.html#logging-howto>`_.
+
Listening for Connection Events
-------------------------------