[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 8/8] docs: add some documentation on avocado logging
|
From: |
Alex Bennée |
|
Subject: |
[PATCH 8/8] docs: add some documentation on avocado logging |
|
Date: |
Thu, 18 May 2023 17:20:34 +0100 |
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
- [PATCH 0/8] testing/next: avocado logging, docs, gitlab, Alex Bennée, 2023/05/18
- [PATCH 6/8] tests/avocado: move guest output to "avocado" namespace, Alex Bennée, 2023/05/18
- [PATCH 5/8] tests/tcg: add mechanism to handle plugin arguments, Alex Bennée, 2023/05/18
- [PATCH 1/8] gitlab: explicit set artifacts publishing criteria, Alex Bennée, 2023/05/18
- [PATCH 2/8] gitlab: ensure coverage job also publishes meson log, Alex Bennée, 2023/05/18