[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 11/32] python/aqmp: add _cb_inbound and _cb_outbound logging hooks
From: |
John Snow |
Subject: |
[PULL 11/32] python/aqmp: add _cb_inbound and _cb_outbound logging hooks |
Date: |
Mon, 27 Sep 2021 15:24:52 -0400 |
Add hooks designed to log/filter incoming/outgoing messages. The primary
intent for these is to be able to support iotests which may want to log
messages with specific filters for reproducible output.
Another use is for plugging into Urwid frameworks; all messages in/out
can be automatically added to a rendering list for the purposes of a
qmp-shell like tool.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 20210915162955.333025-12-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/aqmp/protocol.py | 50 +++++++++++++++++++++++++++++++++---
1 file changed, 46 insertions(+), 4 deletions(-)
diff --git a/python/qemu/aqmp/protocol.py b/python/qemu/aqmp/protocol.py
index 2ef19e96932..80c2004737e 100644
--- a/python/qemu/aqmp/protocol.py
+++ b/python/qemu/aqmp/protocol.py
@@ -177,6 +177,11 @@ class AsyncProtocol(Generic[T]):
can be written after the super() call.
- `_on_message`:
Actions to be performed when a message is received.
+ - `_cb_outbound`:
+ Logging/Filtering hook for all outbound messages.
+ - `_cb_inbound`:
+ Logging/Filtering hook for all inbound messages.
+ This hook runs *before* `_on_message()`.
:param name:
Name used for logging messages, if any. By default, messages
@@ -752,6 +757,43 @@ async def _bh_recv_message(self) -> None:
# Section: Message I/O
# --------------------
+ @upper_half
+ @bottom_half
+ def _cb_outbound(self, msg: T) -> T:
+ """
+ Callback: outbound message hook.
+
+ This is intended for subclasses to be able to add arbitrary
+ hooks to filter or manipulate outgoing messages. The base
+ implementation does nothing but log the message without any
+ manipulation of the message.
+
+ :param msg: raw outbound message
+ :return: final outbound message
+ """
+ self.logger.debug("--> %s", str(msg))
+ return msg
+
+ @upper_half
+ @bottom_half
+ def _cb_inbound(self, msg: T) -> T:
+ """
+ Callback: inbound message hook.
+
+ This is intended for subclasses to be able to add arbitrary
+ hooks to filter or manipulate incoming messages. The base
+ implementation does nothing but log the message without any
+ manipulation of the message.
+
+ This method does not "handle" incoming messages; it is a filter.
+ The actual "endpoint" for incoming messages is `_on_message()`.
+
+ :param msg: raw inbound message
+ :return: processed inbound message
+ """
+ self.logger.debug("<-- %s", str(msg))
+ return msg
+
@upper_half
@bottom_half
async def _do_recv(self) -> T:
@@ -780,8 +822,8 @@ async def _recv(self) -> T:
:return: A single (filtered, processed) protocol message.
"""
- # A forthcoming commit makes this method less trivial.
- return await self._do_recv()
+ message = await self._do_recv()
+ return self._cb_inbound(message)
@upper_half
@bottom_half
@@ -811,7 +853,7 @@ async def _send(self, msg: T) -> None:
:raise OSError: For problems with the underlying stream.
"""
- # A forthcoming commit makes this method less trivial.
+ msg = self._cb_outbound(msg)
self._do_send(msg)
@bottom_half
@@ -826,6 +868,6 @@ async def _on_message(self, msg: T) -> None:
directly cause the loop to halt, so logic may be best-kept
to a minimum if at all possible.
- :param msg: The incoming message
+ :param msg: The incoming message, already logged/filtered.
"""
# Nothing to do in the abstract case.
--
2.31.1
- [PULL 00/32] Python patches, John Snow, 2021/09/27
- [PULL 01/32] python/aqmp: add asynchronous QMP (AQMP) subpackage, John Snow, 2021/09/27
- [PULL 02/32] python/aqmp: add error classes, John Snow, 2021/09/27
- [PULL 04/32] python/aqmp: add asyncio compatibility wrappers, John Snow, 2021/09/27
- [PULL 03/32] python/pylint: Add exception for TypeVar names ('T'), John Snow, 2021/09/27
- [PULL 07/32] python/aqmp: Add logging utility helpers, John Snow, 2021/09/27
- [PULL 05/32] python/aqmp: add generic async message-based protocol support, John Snow, 2021/09/27
- [PULL 06/32] python/aqmp: add runstate state machine to AsyncProtocol, John Snow, 2021/09/27
- [PULL 08/32] python/aqmp: add logging to AsyncProtocol, John Snow, 2021/09/27
- [PULL 10/32] python/aqmp: add configurable read buffer limit, John Snow, 2021/09/27
- [PULL 11/32] python/aqmp: add _cb_inbound and _cb_outbound logging hooks,
John Snow <=
- [PULL 12/32] python/aqmp: add AsyncProtocol._readline() method, John Snow, 2021/09/27
- [PULL 13/32] python/aqmp: add QMP Message format, John Snow, 2021/09/27
- [PULL 14/32] python/aqmp: add well-known QMP object models, John Snow, 2021/09/27
- [PULL 15/32] python/aqmp: add QMP event support, John Snow, 2021/09/27
- [PULL 16/32] python/pylint: disable too-many-function-args, John Snow, 2021/09/27
- [PULL 17/32] python/aqmp: add QMP protocol support, John Snow, 2021/09/27
- [PULL 18/32] python/pylint: disable no-member check, John Snow, 2021/09/27
- [PULL 19/32] python/aqmp: Add message routing to QMP protocol, John Snow, 2021/09/27
- [PULL 21/32] python/aqmp: add _raw() execution interface, John Snow, 2021/09/27
- [PULL 20/32] python/aqmp: add execute() interfaces, John Snow, 2021/09/27