kbase: debuglogs: Include more data to attach to bugreports

Promote the 'What to attach?' section to a first level heading and
request also the XML config of a VM, coredump backtrace if something
crashed and ask to not tear down the environment for the possibility to
ask for additional data.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>

diff --git a/docs/kbase/debuglogs.rst b/docs/kbase/debuglogs.rst
index decc53a69bea6f292e9513c349117beaf8f4544b..1f5fbc481fb0f3d6301196bcc9809961a608129c 100644 (file)
--- a/docs/kbase/debuglogs.rst
+++ b/docs/kbase/debuglogs.rst
@@ -136,13 +136,21 @@ setting which depends on the host configuration, *journald* in our case:
     Logging outputs: 2:journald
 
 What to attach?
-~~~~~~~~~~~~~~~
+---------------
 
 Now you should go and reproduce the bug. Once you're finished, attach:
 
 -  ``/var/log/libvirt/libvirtd.log`` or whatever path you set for the daemon
    logs.
--  If the problem is related to a domain attach
-   ``/var/log/libvirt/qemu/$dom.log`` then. Or substitute ``qemu`` with whatever
-   hypervisor you are using.
+-  If the problem is related to a domain named ``$dom`` attach:
+
+   -  ``/var/log/libvirt/qemu/$dom.log`` (Or substitute ``qemu`` with whatever
+      hypervisor you are using.)
+   -  The XML configuration of the vm/domain obtained by ``virsh dumpxml $dom``
+
+-  If the problem involves a crash of ``libvirtd`` or any other component, also
+   attach the backtrace from the core dump if possible (e.g. using
+   ``coredumpctl``).
 -  If you are asked for client logs, ``/tmp/libvirt_client.log``.
+-  Ideally don't tear down the environment in case additional information is
+   required.