All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Kevin Wolf <kwolf@redhat.com>,
	Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>,
	Eduardo Habkost <ehabkost@redhat.com>,
	qemu-block@nongnu.org, Hanna Reitz <hreitz@redhat.com>,
	Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [PATCH v2 07/17] python/aqmp: Disable logging messages by default
Date: Wed, 22 Sep 2021 20:49:28 -0400	[thread overview]
Message-ID: <20210923004938.3999963-8-jsnow@redhat.com> (raw)
In-Reply-To: <20210923004938.3999963-1-jsnow@redhat.com>

AQMP is a library, and ideally it should not print error diagnostics
unless a user opts into seeing them. By default, Python will print all
WARNING, ERROR or CRITICAL messages to screen if no logging
configuration has been created by a client application.

In AQMP's case, ERROR logging statements are used to report additional
detail about runtime failures that will also eventually be reported to the
client library via an Exception, so these messages should not be
rendered by default.

(Why bother to have them at all, then? In async contexts, there may be
multiple Exceptions and we are only able to report one of them back to
the client application. It is not reasonably easy to predict ahead of
time if one or more of these Exceptions will be squelched. Therefore,
it's useful to log intermediate failures to help make sense of the
ultimate, resulting failure.)

Add a NullHandler that will suppress these messages until a client
application opts into logging via logging.basicConfig or similar. Note
that upon calling basicConfig(), this handler will *not* suppress these
messages from being displayed by the client's configuration.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 python/qemu/aqmp/__init__.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/python/qemu/aqmp/__init__.py b/python/qemu/aqmp/__init__.py
index ab1782999cf..d1b0e4dc3d3 100644
--- a/python/qemu/aqmp/__init__.py
+++ b/python/qemu/aqmp/__init__.py
@@ -21,6 +21,7 @@
 # This work is licensed under the terms of the GNU GPL, version 2.  See
 # the COPYING file in the top-level directory.
 
+import logging
 import warnings
 
 from .error import AQMPError
@@ -41,6 +42,9 @@
 
 warnings.warn(_WMSG, FutureWarning)
 
+# Suppress logging unless an application engages it.
+logging.getLogger('qemu.aqmp').addHandler(logging.NullHandler())
+
 
 # The order of these fields impact the Sphinx documentation order.
 __all__ = (
-- 
2.31.1



  parent reply	other threads:[~2021-09-23  0:59 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-23  0:49 [PATCH v2 00/17] Switch iotests to using Async QMP John Snow
2021-09-23  0:49 ` [PATCH v2 01/17] python/aqmp: add greeting property to QMPClient John Snow
2021-09-23  0:49 ` [PATCH v2 02/17] python/aqmp: add .empty() method to EventListener John Snow
2021-09-23  0:49 ` [PATCH v2 03/17] python/aqmp: Return cleared events from EventListener.clear() John Snow
2021-09-23  0:49 ` [PATCH v2 04/17] python/aqmp: add send_fd_scm John Snow
2021-10-07 14:52   ` Eric Blake
2021-10-07 16:27     ` John Snow
2021-10-07 21:46       ` Eric Blake
2021-09-23  0:49 ` [PATCH v2 05/17] python/aqmp: Add dict conversion method to Greeting object John Snow
2021-10-07 14:53   ` Eric Blake
2021-09-23  0:49 ` [PATCH v2 06/17] python/aqmp: Reduce severity of EOFError-caused loop terminations John Snow
2021-10-07 14:55   ` Eric Blake
2021-09-23  0:49 ` John Snow [this message]
2021-10-07 15:02   ` [PATCH v2 07/17] python/aqmp: Disable logging messages by default Eric Blake
2021-09-23  0:49 ` [PATCH v2 08/17] python/qmp: clear events on get_events() call John Snow
2021-09-23  0:49 ` [PATCH v2 09/17] python/qmp: add send_fd_scm directly to QEMUMonitorProtocol John Snow
2021-09-23  0:49 ` [PATCH v2 10/17] python, iotests: remove socket_scm_helper John Snow
2021-09-23  0:49 ` [PATCH v2 11/17] python/machine: remove has_quit argument John Snow
2021-10-12 15:30   ` Hanna Reitz
2021-09-23  0:49 ` [PATCH v2 12/17] python/machine: Handle QMP errors on close more meticulously John Snow
2021-10-07 15:07   ` Eric Blake
2021-10-07 16:34     ` John Snow
2021-10-07 16:52   ` John Snow
2021-10-12 15:56     ` Hanna Reitz
2021-09-23  0:49 ` [PATCH v2 13/17] iotests: Accommodate async QMP Exception classes John Snow
2021-10-12 16:06   ` Hanna Reitz
2021-10-12 16:38     ` John Snow
2021-09-23  0:49 ` [PATCH v2 14/17] iotests: Conditionally silence certain AQMP errors John Snow
2021-09-23  0:49 ` [PATCH v2 15/17] python/aqmp: Create sync QMP wrapper for iotests John Snow
2021-10-06 10:13   ` Paolo Bonzini
2021-10-06 14:24     ` John Snow
2021-10-06 14:32       ` Paolo Bonzini
2021-10-06 15:12         ` John Snow
2021-09-23  0:49 ` [PATCH v2 16/17] python/aqmp: Remove scary message John Snow
2021-09-23  0:49 ` [PATCH v2 17/17] python, iotests: replace qmp with aqmp John Snow
2021-10-06 10:14 ` [PATCH v2 00/17] Switch iotests to using Async QMP Paolo Bonzini
2021-10-06 15:01   ` John Snow

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210923004938.3999963-8-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=crosa@redhat.com \
    --cc=ehabkost@redhat.com \
    --cc=hreitz@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=vsementsov@virtuozzo.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.