[PATCH 4/8] kbase: debuglogs: Section off the settings for legacy libvirt

[Erik Skultety]

On Mon, Jan 17, 2022 at 04:39:12PM +0100, Peter Krempa wrote:
> Move out the settings required to pre libvirt-4.4.0 deployments into a
> separate section so that the main point is not cluttered by now mostly
> irrelevant settings.
> 
> Signed-off-by: Peter Krempa <pkrempa at redhat.com>
> ---
>  docs/kbase/debuglogs.rst | 48 +++++++++++++++++++++++-----------------
>  1 file changed, 28 insertions(+), 20 deletions(-)
> 
> diff --git a/docs/kbase/debuglogs.rst b/docs/kbase/debuglogs.rst
> index e0115bd23f..cba57e020d 100644
> --- a/docs/kbase/debuglogs.rst
> +++ b/docs/kbase/debuglogs.rst
> @@ -33,14 +33,6 @@ URI <https://libvirt.org/uri.html>`__. For ``qemu:///system``:
> 
>  ::
> 
> -   # 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"
> 
> @@ -51,12 +43,10 @@ URI <https://libvirt.org/uri.html>`__. For ``qemu:///system``:
> 
>     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``.
> +
> +*Note:* Libvirt prior to the ``libvirt-4.4.0`` release didn't support globbing
> +patterns and thus requires more configuration. See
> +`Legacy (pre-4.4.0) libvirt daemon logging configuration`_.
> 
>  In case you want to get the client logs, you need to set this environment
>  variable:
> @@ -91,12 +81,6 @@ 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:
> @@ -193,3 +177,27 @@ This filter logs only QMP traffic and skips most of libvirt's messages.
>  ::
> 
>      2:qemu.qemu_monitor 3:*
> +
> +
> +Legacy (pre-4.4.0) libvirt daemon logging configuration
> +=======================================================

This section should be re-parented under the "Libvirt daemons logging configuration"
as the last section - the reasoning is that it is still related to the section
about the daemon configuration.

> +
> +Old libvirt versions didn't support globbing (e.g. ``1:*``) to configure logging
> +wildcarts, thus it's required to explicitly set logging level to 1 (debug level)

s/wildcarts//     # (globbing is all about wildcards...)

> +via the ``log_level`` setting and then filter out the noise via targetted log
> +filters.

s/via/with/g
s/targetted/a tailored log_filters string


With the adjustments:
Reviewed-by: Erik Skultety <eskultet at redhat.com>

> +
> +::
> +
> +   # LEGACY SETTINGS PRIOR LIBVIRT 4.4.0
> +   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"
> +
> +
> +Or using ``virt-admin``:
> +
> +::
> +
> +   ## LEGACY APPROACH ENUMERATING ALL THE DESIRED MODULES ##
> +   # virt-admin daemon-log-filters "1:util 1:libvirt 1:storage 1:network 1:nodedev 1:qemu"
> -- 
> 2.34.1
>