add pool backoff message

Author: blink1073

pymongo/asynchronous/pool.py

@@ -1029,7 +1029,7 @@ async def remove_stale_sockets(self, reference_generation: int) -> None:
                     self.requests -= 1
                     self.size_cond.notify()
 
-    def _handle_connection_error(self, error: BaseException, phase: str) -> None:
+    def _handle_connection_error(self, error: BaseException, phase: str, conn_id: int) -> None:
         # Handle system overload condition for non-sdam pools.
         # Look for an AutoReconnect error raised from a ConnectionResetError with
         # errno == errno.ECONNRESET or raised from an OSError that we've created due to
@@ -1040,7 +1040,18 @@ def _handle_connection_error(self, error: BaseException, phase: str) -> None:
         self._backoff += 1
         error._add_error_label("SystemOverloadedError")
         error._add_error_label("RetryableError")
-        print(f"Setting backoff in {phase}:", self._backoff)  # noqa: T201
+        # Log the pool backoff message.
+        if self.enabled_for_logging and _CONNECTION_LOGGER.isEnabledFor(logging.DEBUG):
+            _debug_log(
+                _CONNECTION_LOGGER,
+                message=_ConnectionStatusMessage.POOL_BACKOFF,
+                clientId=self._client_id,
+                serverHost=self.address[0],
+                serverPort=self.address[1],
+                driverConnectionId=conn_id,
+                reason=_verbose_connection_error_reason(ConnectionClosedReason.POOL_BACKOFF),
+                error=ConnectionClosedReason.POOL_BACKOFF,
+            )
 
     async def connect(self, handler: Optional[_MongoClientErrorHandler] = None) -> AsyncConnection:
         """Connect to Mongo and return a new AsyncConnection.
@@ -1103,7 +1114,7 @@ async def connect(self, handler: Optional[_MongoClientErrorHandler] = None) -> A
                     error=ConnectionClosedReason.ERROR,
                 )
             if context["has_created_socket"]:
-                self._handle_connection_error(error, "handshake")
+                self._handle_connection_error(error, "handshake", conn_id)
             if isinstance(error, (IOError, OSError, *SSLErrors)):
                 details = _get_timeout_details(self.opts)
                 _raise_connection_failure(self.address, error, timeout_details=details)
@@ -1127,7 +1138,7 @@ async def connect(self, handler: Optional[_MongoClientErrorHandler] = None) -> A
         except BaseException as e:
             async with self.lock:
                 self.active_contexts.discard(conn.cancel_context)
-            self._handle_connection_error(e, "hello")
+            self._handle_connection_error(e, "hello", conn_id)
             await conn.close_conn(ConnectionClosedReason.ERROR)
             raise
 

pymongo/logger.py

@@ -42,6 +42,7 @@ class _ConnectionStatusMessage(str, enum.Enum):
     POOL_READY = "Connection pool ready"
     POOL_CLOSED = "Connection pool closed"
     POOL_CLEARED = "Connection pool cleared"
+    POOL_BACKOFF = "Connection pool backoff"
 
     CONN_CREATED = "Connection created"
     CONN_READY = "Connection ready"
@@ -88,6 +89,7 @@ class _SDAMStatusMessage(str, enum.Enum):
 _VERBOSE_CONNECTION_ERROR_REASONS = {
     ConnectionClosedReason.POOL_CLOSED: "Connection pool was closed",
     ConnectionCheckOutFailedReason.POOL_CLOSED: "Connection pool was closed",
+    ConnectionClosedReason.POOL_BACKOFF: "Connection pool is in backoff",
     ConnectionClosedReason.STALE: "Connection pool was stale",
     ConnectionClosedReason.ERROR: "An error occurred while using the connection",
     ConnectionCheckOutFailedReason.CONN_ERROR: "An error occurred while trying to establish a new connection",

pymongo/synchronous/pool.py

@@ -1025,7 +1025,7 @@ def remove_stale_sockets(self, reference_generation: int) -> None:
                     self.requests -= 1
                     self.size_cond.notify()
 
-    def _handle_connection_error(self, error: BaseException, phase: str) -> None:
+    def _handle_connection_error(self, error: BaseException, phase: str, conn_id: int) -> None:
         # Handle system overload condition for non-sdam pools.
         # Look for an AutoReconnect error raised from a ConnectionResetError with
         # errno == errno.ECONNRESET or raised from an OSError that we've created due to
@@ -1036,7 +1036,18 @@ def _handle_connection_error(self, error: BaseException, phase: str) -> None:
         self._backoff += 1
         error._add_error_label("SystemOverloadedError")
         error._add_error_label("RetryableError")
-        print(f"Setting backoff in {phase}:", self._backoff)  # noqa: T201
+        # Log the pool backoff message.
+        if self.enabled_for_logging and _CONNECTION_LOGGER.isEnabledFor(logging.DEBUG):
+            _debug_log(
+                _CONNECTION_LOGGER,
+                message=_ConnectionStatusMessage.POOL_BACKOFF,
+                clientId=self._client_id,
+                serverHost=self.address[0],
+                serverPort=self.address[1],
+                driverConnectionId=conn_id,
+                reason=_verbose_connection_error_reason(ConnectionClosedReason.POOL_BACKOFF),
+                error=ConnectionClosedReason.POOL_BACKOFF,
+            )
 
     def connect(self, handler: Optional[_MongoClientErrorHandler] = None) -> Connection:
         """Connect to Mongo and return a new Connection.
@@ -1099,7 +1110,7 @@ def connect(self, handler: Optional[_MongoClientErrorHandler] = None) -> Connect
                     error=ConnectionClosedReason.ERROR,
                 )
             if context["has_created_socket"]:
-                self._handle_connection_error(error, "handshake")
+                self._handle_connection_error(error, "handshake", conn_id)
             if isinstance(error, (IOError, OSError, *SSLErrors)):
                 details = _get_timeout_details(self.opts)
                 _raise_connection_failure(self.address, error, timeout_details=details)
@@ -1123,7 +1134,7 @@ def connect(self, handler: Optional[_MongoClientErrorHandler] = None) -> Connect
         except BaseException as e:
             with self.lock:
                 self.active_contexts.discard(conn.cancel_context)
-            self._handle_connection_error(e, "hello")
+            self._handle_connection_error(e, "hello", conn_id)
             conn.close_conn(ConnectionClosedReason.ERROR)
             raise