Bug 2073867

Summary: Missing the doc of dirtyrate.calc_mode and dirtyrate.vcpu.<num>.megabytes_per_second
Product: Red Hat Enterprise Linux 9 Reporter: Lili Zhu <lizhu>
Component: libvirtAssignee: Peter Krempa <pkrempa>
libvirt sub component: General QA Contact: zhentang <zhetang>
Status: CLOSED ERRATA Docs Contact:
Severity: unspecified    
Priority: unspecified CC: jdenemar, lmen, peterx, pkrempa, virt-maint, xiaohli, xuzhang
Version: 9.1Keywords: Triaged
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: libvirt-8.3.0-1.el9 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-11-15 10:04:06 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version: 8.3.0
Embargoed:

Description Lili Zhu 2022-04-11 01:38:16 UTC
Description of problem:
Missing the doc of dirtyrate.calc_mode and dirtyrate.vcpu.<num>.megabytes_per_second

Version-Release number of selected component (if applicable):
libvirt-8.2.0-1.el9.x86_64

How reproducible:
100%

Steps to Reproduce:
1. Check the doc of virsh
# man virsh
...
domstats
       Syntax:
...
  --dirtyrate returns:

       • dirtyrate.calc_status - the status of last memory dirty rate calculation, returned as number from virDomainDirtyRateStatus enum.

       • dirtyrate.calc_start_time - the start time of last memory dirty rate calculation.

       • dirtyrate.calc_period - the period of last memory dirty rate calculation.

       • dirtyrate.megabytes_per_second - the calculated memory dirty rate in MiB/s.

       Selecting a specific statistics groups doesn't guarantee that the daemon supports the selected group of stats. Flag --enforce forces the command to fail if the daemon
       doesn't support the selected group.



Actual results:
Missing the doc of dirtyrate.calc_mode and dirtyrate.vcpu.<num>.megabytes_per_second

Expected results:


Additional info:

Comment 1 Peter Krempa 2022-04-13 11:08:35 UTC
Fixed upstream:

commit 67263604e60fbefe3b85560b81001e18a1e39533
Author: Peter Krempa <pkrempa>
Date:   Tue Apr 12 14:05:39 2022 +0200

    docs: man: Add description of 'calc_mode' and 'vcpu.<num>.megabytes_per_second' dirtyrate mode
    
    Commit 42d36b65a31 added new fields to the API docs but didn't add the
    virsh man page equivalent.
    
    Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=2073867
    Signed-off-by: Peter Krempa <pkrempa>
    Reviewed-by: Ján Tomko <jtomko>

v8.2.0-143-g67263604e6

Comment 4 zhentang 2022-05-23 03:51:50 UTC
Verified

version libvirt-8.3.0-1.el9

1. Check the doc of virsh
# man virsh

 --dirtyrate returns:

       • dirtyrate.calc_status - the status of last memory dirty rate calcula‐
         tion, returned as number from virDomainDirtyRateStatus enum.

       • dirtyrate.calc_start_time - the start time of last memory dirty  rate
         calculation.

       • dirtyrate.calc_period - the period of last memory dirty rate calcula‐
         tion.

       • dirtyrate.megabytes_per_second - the calculated memory dirty rate  in
         MiB/s.

       • dirtyrate.calc_mode  -  the  calculation  mode  used last measurement
         (page-sampling/dirty-bitmap/dirty-ring)

       • dirtyrate.vcpu.<num>.megabytes_per_second  -  the  calculated  memory
         dirty rate for a virtual cpu in MiB/s

Comment 6 errata-xmlrpc 2022-11-15 10:04:06 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Low: libvirt security, bug fix, and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2022:8003