Bug 834208

Summary: [RFE]virt-top need to describe fields in manual
Product: Red Hat Enterprise Linux 6 Reporter: yuping zhang <yupzhang>
Component: virt-topAssignee: Richard W.M. Jones <rjones>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.4CC: dyasny, jwu, mzhan, rwu, yupzhang, zpeng
Target Milestone: rcKeywords: FutureFeature
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: virt-top-1.0.4-3.14.el6 Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-02-21 10:07:54 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:
Embargoed:

Description yuping zhang 2012-06-21 08:44:24 UTC
Description of problem:
In virt-top manual,there is no description about fields.

Version-Release number of selected component (if applicable):
virt-top-1.0.4-3.13.el6.x86_64

How reproducible:
always

Steps to Reproduce:
1.#virt-top
virt-top 21:15:01 - x86_64 4/4CPU 2659MHz 7806MB
10 domains, 3 active, 2 running, 0 sleeping, 1 paused, 7 inactive D:0 O:0 X:0
CPU: 0.0%  Mem: 3072 MB (3072 MB by guests)

   ID S RDRQ WRRQ RXBY TXBY %CPU %MEM    TIME   NAME
    5 P                      0.0  0.0   0:01.81 demo
    4 R                      0.0  0.0   3:16.13 rhel6.3
    2 R                      0.0  0.0   1:07.86 test-cpu

2.Press B
virt-top 21:15:39 - x86_64 4/4CPU 2659MHz 7806MB 0.1%
10 domains, 3 active, 2 running, 0 sleeping, 1 paused, 7 inactive D:0 O:0 X:0
CPU: 0.0%  Mem: 3072 MB (3072 MB by guests)

   ID S RDBY WRBY RXBY TXBY %CPU %MEM    TIME   NAME
    5 P    0    0  104    0  0.0 13.0   0:01.84 demo
    4 R    0 4096   52    0  0.0 13.0   3:16.21 rhel6.3
    2 R    0    0   52    0  0.0 13.0   1:07.89 test-cpu

3.#man virt-top

Actual results:
The fields "ID S RDRQ WRRQ RXBY TXBY %CPU %MEM    TIME   NAME RDBY WRBY" aren't described in manual

Expected results:
Like #man top,add all fields description in virt-top manual.

Additional info:

Comment 1 RHEL Program Management 2012-07-10 06:18:49 UTC
This request was not resolved in time for the current release.
Red Hat invites you to ask your support representative to
propose this request, if still desired, for consideration in
the next release of Red Hat Enterprise Linux.

Comment 2 RHEL Program Management 2012-07-11 01:58:42 UTC
This request was erroneously removed from consideration in Red Hat Enterprise Linux 6.4, which is currently under development.  This request will be evaluated for inclusion in Red Hat Enterprise Linux 6.4.

Comment 4 yuping zhang 2012-09-29 06:50:37 UTC
Test this issue with virt-top-1.0.4-3.14.el6.x86_64.
#man virt-top
...
COLUMN HEADINGS
       %CPU
           Percentage of CPU used.  As with top(1), 100% means that all physical
           CPUs are being fully used.

       DEVICE
           The block device name.

       DOMAIN               ##################Does "DOMAIN" need to be removed?
       NAME                          
           The name of the libvirt domain.

       ID  The libvirt domain ID.

       INTERFACE
           The network interface name.

       %MEM
           The percentage of host memory assigned to the guest.

       PHYCPU
           The physical CPU.

       RDBY
           Disk bytes read since last displayed.

       RDRQ
           Disk read requests since last displayed.

       RXBY
           Network bytes received since last displayed.

       RXPK
           Network packets received since last displayed.

       S   The state of the domain, one of:

           ?   Unknown.

           R   Running.

           S   Blocked.

           P   Paused.

           D
           O   Shutdown. ################## Does D or O mean Shutdown? 

           X   Crashed.

       TIME
           Total CPU time used.

       TXBY
           Network bytes transmitted since last displayed.

       TXPK
           Network packets transmitted since last displayed.

       WRBY
           Disk bytes written since last displayed.

       WRRQ
           Disk write requests since last displayed.

Hi Richard,
I saw column headings was added to virt-top,but there are still some problems I need to confirm with you. Two problems I have marked above,please see the sentence start with "###". 
And the third problems is how could we see all states of domain.
There are 6 states,but now we can only see R and P,the state will not be displayed when shutdown guest.

Comment 5 Richard W.M. Jones 2012-09-29 07:46:46 UTC
virt-top prints "DOMAIN" instead of "NAME" in some views,
eg try virt-top -2

virt-top 08:45:45 - x86_64 4/4CPU 1199MHz 7762MB
24 domains, 0 active, 0 running, 0 sleeping, 0 paused, 24 inactive D:0 O:0 X:0
CPU: 0.0%  Mem: 0 MB (0 MB by guests)

   ID S RXBY TXBY RXPK TXPK DOMAIN       INTERFACE                              

The libvirt shutdown states are 'D' and 'O'.  I don't know
how they differ, but they both mean approximately the
same thing.

Comment 6 yuping zhang 2012-09-29 07:57:13 UTC
(In reply to comment #5)
> virt-top prints "DOMAIN" instead of "NAME" in some views,
> eg try virt-top -2
> 
> virt-top 08:45:45 - x86_64 4/4CPU 1199MHz 7762MB
> 24 domains, 0 active, 0 running, 0 sleeping, 0 paused, 24 inactive D:0 O:0
> X:0
> CPU: 0.0%  Mem: 0 MB (0 MB by guests)
> 
>    ID S RXBY TXBY RXPK TXPK DOMAIN       INTERFACE                          
> 
> 
> The libvirt shutdown states are 'D' and 'O'.  I don't know
> how they differ, but they both mean approximately the
> same thing.

I got it.Thanks.
Change the bug status to VERIFIED.

Comment 8 errata-xmlrpc 2013-02-21 10:07:54 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, and where to find the updated
files, follow the link below.

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

http://rhn.redhat.com/errata/RHBA-2013-0391.html