feat: add backlog functionality logging

Author: u-chaCP

packets/packet_queue.py

@@ -1,6 +1,10 @@
 # Copyright (C) Code Partners Pty. Ltd. All rights reserved. #
+import logging
+
 from packets.packet import Packet
 
+logger = logging.getLogger(__name__)
+
 
 class PacketQueueItem:
     def __init__(self, packet: Packet):
@@ -32,6 +36,7 @@ def push(self, packet: Packet) -> None:
 
         self.__count += 1
         self.__size += packet.size + self.__OVERHEAD
+        logger.debug("Added packet {} to PacketQueue. Queue size is: {}".format(id(packet), self.__size))
         self.__resize()
 
     def pop(self) -> (Packet, None):
@@ -50,6 +55,7 @@ def pop(self) -> (Packet, None):
 
         self.__count -= 1
         self.__size -= packet.size + self.__OVERHEAD
+        logging.debug("Popped packet %d" % id(packet))
         return packet
 
     def clear(self) -> None:
@@ -58,6 +64,7 @@ def clear(self) -> None:
 
     def __resize(self) -> None:
         while self.__backlog < self.__size:
+            logger.debug("Queue size exceeds limit set by backlog.queue option (%d). Popping packet." % self.__backlog)
             if self.pop() is None:
                 self.__size = 0
                 break

protocols/protocol.py

@@ -266,8 +266,18 @@ def _impl_write_packet(self, packet: Packet) -> None:
                 if self.__backlog_enabled:
                     if (level.value >= self.__backlog_flushon.value and
                             level != Level.CONTROL):
+
+                        logger.debug("Packet level {} >= backlog flushon level {}. Flushing queue.".format(
+                            level,
+                            self.__backlog_flushon))
+
                         self.__flush_queue()
                     else:
+                        logger.debug("Packet level {} < backlog flushon level {}. Pushing packet {} to queue.".format(
+                            level,
+                            self.__backlog_flushon,
+                            id(packet)))
+
                         self.__queue.push(packet)
                         skip = True
 
@@ -385,10 +395,13 @@ def __flush_queue(self) -> None:
     def __forward_packet(self, packet: Packet, disconnect: bool) -> None:
         if not self._connected:
             if not self.__keep_open:
+                logger.debug("Protocol is not connected. Keep open is {}. Connecting.".format(self.__keep_open))
+
                 self._internal_connect()
                 self._connected = True
                 self.__failed = False
             else:
+                logger.debug("Protocol is not connected. Keep open is {}. Reconnecting.".format(self.__keep_open))
                 self.__do_reconnect()
 
         if self._connected: