From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Markus Armbruster" <armbru@redhat.com>,
"Richard Henderson" <richard.henderson@linaro.org>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Thomas Huth" <thuth@redhat.com>, "John Snow" <jsnow@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Mark Cave-Ayland" <mark.cave-ayland@ilande.co.uk>,
"Wainer dos Santos Moschetta" <wainersm@redhat.com>,
"Cleber Rosa" <crosa@redhat.com>,
"Beraldo Leal" <bleal@redhat.com>
Subject: [PATCH 8/8] docs: add some documentation on avocado logging
Date: Thu, 18 May 2023 17:20:34 +0100 [thread overview]
Message-ID: <20230518162034.1277885-9-alex.bennee@linaro.org> (raw)
In-Reply-To: <20230518162034.1277885-1-alex.bennee@linaro.org>
While we have fixed the logging to go under the avocado name space we
might as well mention the useful "--show" option and the streams you
can use it on.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
docs/devel/testing.rst | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index 8f18052ba7..77402a0daf 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -983,6 +983,31 @@ of Avocado or ``make check-avocado``, and can also be queried using:
tests/venv/bin/avocado list tests/avocado
+Logs
+^^^^
+
+Avocado collects anything logged under the 'avocado.*' name space in
+the log files for a given run. You can also use the ``--show`` option
+to dump selected logging streams directly to stdout:
+
+ .. code::
+
+ tests/venv/bin/avocado --show avocado.qemu.machine run tests/avocado/$TESTFILE:$TESTCLASS.$TESTNAME
+
+There are a number of useful streams you can select.
+
+.. list-table:: Avocado Logging Streams
+ :header-rows: 1
+
+ * - Stream Name
+ - Contents
+ * - avocado.qemu.machine
+ - VM lifecycle including the launch command
+ * - avocado.guest.console
+ - Serial console interactions
+ * - avocado.guest.ssh
+ - ssh interactions
+
Manual Installation
~~~~~~~~~~~~~~~~~~~
--
2.39.2
prev parent reply other threads:[~2023-05-18 16:21 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-18 16:20 [PATCH 0/8] testing/next: avocado logging, docs, gitlab Alex Bennée
2023-05-18 16:20 ` [PATCH 1/8] gitlab: explicit set artifacts publishing criteria Alex Bennée
2023-05-18 16:20 ` [PATCH 2/8] gitlab: ensure coverage job also publishes meson log Alex Bennée
2023-05-18 16:20 ` [PATCH 3/8] docs/devel: remind developers to run CI container pipeline when updating images Alex Bennée
2023-05-18 16:20 ` [PATCH 4/8] accel/tcg: Fix append_mem_cb Alex Bennée
2023-05-18 16:20 ` [PATCH 5/8] tests/tcg: add mechanism to handle plugin arguments Alex Bennée
2023-05-18 16:20 ` [PATCH 6/8] tests/avocado: move guest output to "avocado" namespace Alex Bennée
2023-05-18 16:20 ` [PATCH 7/8] python/qemu: allow avocado to set logging name space Alex Bennée
2023-05-18 20:15 ` John Snow
2023-05-19 6:38 ` Alex Bennée
2023-05-22 19:11 ` John Snow
2023-05-23 7:18 ` Daniel P. Berrangé
2023-05-18 16:20 ` Alex Bennée [this message]
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=20230518162034.1277885-9-alex.bennee@linaro.org \
--to=alex.bennee@linaro.org \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=bleal@redhat.com \
--cc=crosa@redhat.com \
--cc=jsnow@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=mark.cave-ayland@ilande.co.uk \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=richard.henderson@linaro.org \
--cc=thuth@redhat.com \
--cc=wainersm@redhat.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).