From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Mon, 1 Jul 2019 19:45:01 +0000 (+0100)
Subject: bpo-37470: Document more clearly the error handling for QueueHandler.emit(). (GH... 
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0f4e8132820947d93eccf31b9e526b81c6ffa53d;p=python

bpo-37470: Document more clearly the error handling for QueueHandler.emit(). (GH-14532)
---

diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index 592d7e5daf..b7445a135b 100644
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -1001,7 +1001,12 @@ possible, while any potentially slow operations (such as sending an email via
 
    .. method:: emit(record)
 
-      Enqueues the result of preparing the LogRecord.
+      Enqueues the result of preparing the LogRecord. Should an exception
+      occur (e.g. because a bounded queue has filled up), the
+      :meth:`~logging.Handler.handleError` method is called to handle the
+      error. This can result in the record silently being dropped (if
+      :attr:`logging.raiseExceptions` is ``False``) or a message printed to
+      ``sys.stderr`` (if :attr:`logging.raiseExceptions` is ``True``).
 
    .. method:: prepare(record)