--debug for printing logging events passing by.

bombela · bombela · commit 850e3302b2a8 · 2014-09-13T01:14:53.000-07:00
- zerorpc cli accepts --debug or -d, this turn on DEBUG level logging
   and active low level events debugging on the zerorpc object.
 - a zerorpc.SocketBase exposes a new boolean property debug
diff --git a/zerorpc/channel.py b/zerorpc/channel.py
@@ -27,6 +27,7 @@
 import gevent.event
 import gevent.local
 import gevent.lock
+import logging
 
 from .exceptions import TimeoutExpired
 from .channel_base import ChannelBase
@@ -122,6 +123,7 @@ def __init__(self, multiplexer, from_event=None):
             self._channel_id = from_event.header['message_id']
             self._zmqid = from_event.identity
             self._multiplexer._active_channels[self._channel_id] = self
+            logging.debug('<-- new channel %s', self._channel_id)
             self._queue.put(from_event)
 
     @property
@@ -135,13 +137,15 @@ def emit_is_supported(self):
     def close(self):
         if self._channel_id is not None:
             del self._multiplexer._active_channels[self._channel_id]
+            logging.debug('-x- closed channel %s', self._channel_id)
             self._channel_id = None
 
     def new_event(self, name, args, xheader=None):
         event = self._multiplexer.new_event(name, args, xheader)
         if self._channel_id is None:
             self._channel_id = event.header['message_id']
             self._multiplexer._active_channels[self._channel_id] = self
+            logging.debug('--> new channel %s', self._channel_id)
         else:
             event.header['response_to'] = self._channel_id
         event.identity = self._zmqid
diff --git a/zerorpc/cli.py b/zerorpc/cli.py
@@ -69,6 +69,9 @@
 parser.add_argument('--active-hb', default=False, action='store_true',
                     help='enable active heartbeat. The default is to \
                     wait for the server to send the first heartbeat')
+parser.add_argument('-d', '--debug', default=False, action='store_true',
+                    help='Print zerorpc debug msgs, \
+                    like outgoing and incomming messages.')
 parser.add_argument('address', nargs='?', help='address to connect to. Skip \
                     this if you specified --connect or --bind at least once')
 parser.add_argument('command', nargs='?',
@@ -110,6 +113,8 @@ def run_server(args):
         server_obj = server_obj()
 
     server = zerorpc.Server(server_obj, heartbeat=args.heartbeat)
+    if args.debug:
+        server.debug = True
     setup_links(args, server)
     print 'serving "{0}"'.format(server_obj_path)
     return server.run()
@@ -209,6 +214,8 @@ def zerorpc_inspect(client, method=None, long_doc=True, include_argspec=True):
 def run_client(args):
     client = zerorpc.Client(timeout=args.timeout, heartbeat=args.heartbeat,
             passive_heartbeat=not args.active_hb)
+    if args.debug:
+        client.debug = True
     setup_links(args, client)
     if not args.command:
         (longest_name_len, detailled_methods) = zerorpc_inspect(client,
@@ -257,6 +264,9 @@ def main():
     logging.basicConfig()
     args = parser.parse_args()
 
+    if args.debug:
+        logging.getLogger().setLevel(logging.DEBUG)
+
     if args.bind or args.connect:
         if args.command:
             args.params.insert(0, args.command)
diff --git a/zerorpc/events.py b/zerorpc/events.py
@@ -29,7 +29,7 @@
 import gevent.event
 import gevent.local
 import gevent.lock
-
+import logging
 
 import gevent_zmq as zmq
 from .exceptions import TimeoutExpired
@@ -218,6 +218,7 @@ def __str__(self, ignore_args=False):
 
 class Events(ChannelBase):
     def __init__(self, zmq_socket_type, context=None):
+        self._debug = False
         self._zmq_socket_type = zmq_socket_type
         self._context = context or Context.get_instance()
         self._socket = self._context.socket(zmq_socket_type)
@@ -262,6 +263,19 @@ def close(self):
             pass
         self._socket.close()
 
+    @property
+    def debug(self):
+        return self._debug
+
+    @debug.setter
+    def debug(self, v):
+        if v != self._debug:
+            self._debug = v
+            if self._debug:
+                logging.debug('debug enabled')
+            else:
+                logging.debug('debug disabled')
+
     def _resolve_endpoint(self, endpoint, resolve=True):
         if resolve:
             endpoint = self._context.hook_resolve_endpoint(endpoint)
@@ -276,12 +290,14 @@ def connect(self, endpoint, resolve=True):
         r = []
         for endpoint_ in self._resolve_endpoint(endpoint, resolve):
             r.append(self._socket.connect(endpoint_))
+            logging.debug('connected to %s (status=%s)', endpoint_, r[-1])
         return r
 
     def bind(self, endpoint, resolve=True):
         r = []
         for endpoint_ in self._resolve_endpoint(endpoint, resolve):
             r.append(self._socket.bind(endpoint_))
+            logging.debug('bound to %s (status=%s)', endpoint_, r[-1])
         return r
 
     def new_event(self, name, args, xheader=None):
@@ -291,6 +307,8 @@ def new_event(self, name, args, xheader=None):
         return event
 
     def emit_event(self, event, timeout=None):
+        if self._debug:
+            logging.debug('--> %s', event)
         if event.identity:
             parts = list(event.identity or list())
             parts.extend(['', event.pack()])
@@ -313,6 +331,8 @@ def recv(self, timeout=None):
             blob = parts[0]
         event = Event.unpack(blob)
         event.identity = identity
+        if self._debug:
+            logging.debug('<-- %s', event)
         return event
 
     def setsockopt(self, *args):
diff --git a/zerorpc/socket.py b/zerorpc/socket.py
@@ -41,3 +41,11 @@ def connect(self, endpoint, resolve=True):
 
     def bind(self, endpoint, resolve=True):
         return self._events.bind(endpoint, resolve)
+
+    @property
+    def debug(self):
+        return self._events.debug
+
+    @debug.setter
+    def debug(self, v):
+        self._events.debug = v
