mirror of
https://github.com/libvirt/libvirt.git
synced 2025-02-25 18:55:26 -06:00
492c4628a1
Provide debug log configuration insight in our kbase. There are two modifications of the document compared to the wiki version: 1) The link for reporting a bug agains libvirt was modified to use the gitlab issue tracker. 2) The link to URI specification details is changed to 'https' protocol. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
149 lines
4.8 KiB
ReStructuredText
149 lines
4.8 KiB
ReStructuredText
==========
|
|
Debug Logs
|
|
==========
|
|
|
|
.. contents::
|
|
|
|
Turning on debug logs
|
|
---------------------
|
|
|
|
If you `report a bug <https://gitlab.com/libvirt/libvirt/-/issues/new>`__
|
|
against libvirt, in most cases you will be asked to attach debug logs. These
|
|
are bare text files which tracks transition between different states of
|
|
libvirtd, what it has tried to achieve, etc. Because of client -- server schema
|
|
used in libvirt, the logs can be either client or server too. Usually, it's
|
|
server side that matters as nearly all interesting work takes place there.
|
|
Moreover, libvirt catches stderr of all running domains. These can be useful as
|
|
well.
|
|
|
|
|
|
How to turn on debug logs for libvirt
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Persistent setting
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
The daemon configuration files location is dependent on `connection
|
|
URI <https://libvirt.org/uri.html>`__. For ``qemu:///system``:
|
|
|
|
|
|
|
|
- open ``/etc/libvirt/libvirtd.conf`` in your favourite editor
|
|
- find & replace, or set these variables:
|
|
|
|
::
|
|
|
|
# LEGACY SETTINGS PRIOR LIBVIRT 4.4.0 SEE BELOW! #
|
|
log_level = 1
|
|
log_filters="1:qemu 3:remote 4:event 3:util.json 3:rpc"
|
|
log_outputs="1:file:/var/log/libvirt/libvirtd.log"
|
|
|
|
::
|
|
|
|
# PREFERRED SETTINGS AFTER LIBVIRT 4.4.0 #
|
|
log_filters="3:remote 4:event 3:util.json 3:rpc 1:*"
|
|
log_outputs="1:file:/var/log/libvirt/libvirtd.log"
|
|
|
|
- save and exit
|
|
- restart libvirtd service
|
|
|
|
::
|
|
|
|
systemctl restart libvirtd.service
|
|
|
|
In the config variables above, we have set logging level to 1 (debug level), set
|
|
some filters (to filter out noise), e.g. from rpc only warnings (=level 3) and
|
|
above will be reported. The logs are saved into
|
|
``/var/log/libvirt/libvirtd.log``. Since libvirt **4.4.0** log filters support
|
|
shell globbing, therefore the usage of ``log_level`` is considered deprecated in
|
|
favour of pure usage of ``log_filters``.
|
|
|
|
In case you want to get the client logs, you need to set this environment
|
|
variable:
|
|
|
|
::
|
|
|
|
export LIBVIRT_LOG_OUTPUTS="1:file:/tmp/libvirt_client.log"
|
|
|
|
|
|
However, when you are using the session mode ``qemu:///session`` or you run the
|
|
``libvirtd`` as unprivileged user you will find configuration file under
|
|
``$XDG_CONFIG_HOME/libvirt/libvirt.conf``.
|
|
|
|
Runtime setting
|
|
^^^^^^^^^^^^^^^
|
|
|
|
Debugging anomalies can be very painful, especially when trying to reproduce it
|
|
after the daemon restarts, since the new session can make the anomaly
|
|
"disappear". Therefore, it's possible to enable the debug logs during runtime
|
|
using libvirt administration API. To use it conveniently, there's a virt-admin
|
|
client provided by the libvirt-admin package. Use the package manager provided
|
|
by your distribution to install this package. Once you have it installed, run
|
|
the following as root to see the set of log filters currently being active:
|
|
|
|
::
|
|
|
|
# virt-admin daemon-log-filters
|
|
Logging filters: 3:remote 4:util.json 4:rpc
|
|
|
|
In order to change this set, run the same command as root, this time with your
|
|
own set of filters:
|
|
|
|
::
|
|
|
|
## LEGACY APPROACH ENUMERATING ALL THE DESIRED MODULES ##
|
|
# virt-admin daemon-log-filters "1:util 1:libvirt 1:storage 1:network 1:nodedev 1:qemu"
|
|
|
|
::
|
|
|
|
## CURRENT APPROACH USING SHELL GLOBBING ##
|
|
# virt-admin daemon-log-filters "3:remote 4:util.json 4:rpc 1:*"
|
|
|
|
Analogically, the same procedure can be performed with log outputs:
|
|
|
|
::
|
|
|
|
# virt-admin daemon-log-outputs
|
|
Logging outputs: 3:syslog:libvirtd
|
|
# virt-admin daemon-log-outputs "1:file:/var/log/libvirt/libvirtd.log"
|
|
|
|
NOTE: It's always good practice to return the settings to the original state
|
|
once you're finished debugging, just remember to save the original sets of
|
|
filters and outputs and restore them at the end the same way as described above.
|
|
|
|
Removing filters and outputs
|
|
''''''''''''''''''''''''''''
|
|
|
|
It's also possible to remove all the filters and produce an enormous log file,
|
|
but it is not recommended since some of libvirt's modules can produce a large
|
|
amount of noise. However, should you really want to do this, you can specify an
|
|
empty set of filters:
|
|
|
|
::
|
|
|
|
# virt-admin daemon-log-filters ""
|
|
Logging filters:
|
|
|
|
The situation is a bit different with outputs, since libvirt always has to log
|
|
somewhere and resetting the outputs to an empty set will restore the default
|
|
setting which depends on the host configuration, *journald* in our case:
|
|
|
|
::
|
|
|
|
# virt-admin daemon-log-outputs
|
|
Logging outputs: 1:file:/var/log/libvirt/libvirtd.log
|
|
# virt-admin daemon-log-outputs ""
|
|
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 you are asked for client logs, ``/tmp/libvirt_client.log``.
|