diff mbox series

[8/8] docs: add some documentation on avocado logging

Message ID 20230518162034.1277885-9-alex.bennee@linaro.org
State New
Headers show
Series testing/next: avocado logging, docs, gitlab | expand

Commit Message

Alex Bennée May 18, 2023, 4:20 p.m. UTC 
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 mbox series

Patch

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
 ~~~~~~~~~~~~~~~~~~~