Bug 1373263

Summary: Instruction for per-session part of spice-vdagent missing (Administration Guide - Table 18.4)
Product: Red Hat Enterprise Virtualization Manager Reporter: David Jaša <djasa>
Component: DocumentationAssignee: Emma Heftman <eheftman>
Status: CLOSED CURRENTRELEASE QA Contact: Tahlia Richardson <trichard>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 4.0.3CC: djasa, gklein, lbopf, lsurette, rbalakri, srevivo, trichard, uril, ykaul
Target Milestone: ovirt-4.0.7   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-02-21 16:37:57 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Docs RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description David Jaša 2016-09-05 15:56:37 UTC
Description of problem:
spice-vdagent on Linux is two-part just as in Windows but documentation (Administration Guide - Table 18.4) captures just system part that is responsible for message passing between server (and by extension, client) and per-session part.

To get debug output of per-session part of the agent, it has to be killed in the session to be debugged and restarted in foreground with debug output on:
$ killall spice-vdagent
$ spice-vdagent -x -d [-d] [ | tee spice-vdagent.log ]

Version-Release number of selected component (if applicable):
4.0.4

How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:
direct link: https://access.redhat.com/documentation/en/red-hat-virtualization/4.0/single/administration-guide/#idm140139776698608

Comment 1 Lucy Bopf 2017-01-19 13:35:35 UTC
Assigning to Emma for review.

Comment 3 Uri Lublin 2017-01-30 16:37:59 UTC
(In reply to David Jaša from comment #0)
I think David has a good point, especially as this can be done without root permissions.

A few comments:

> Description of problem:
> spice-vdagent on Linux is two-part just as in Windows but documentation
> (Administration Guide - Table 18.4) captures just system part that is

That's probably Table 19.4 here

> responsible for message passing between server (and by extension, client)
> and per-session part.
> 
> To get debug output of per-session part of the agent, it has to be killed in
> the session to be debugged and restarted in foreground with debug output on:
> $ killall spice-vdagent

This works but
perhaps we should come up with a command that does not try to kill other users processes.

> $ spice-vdagent -x -d [-d] [ | tee spice-vdagent.log ]

Here it should be "|&"        ^^^
Apparently spice-vdagent writes to stderr.


In addition:
The reference to /var/log/vdagent.log should be removed
and instead tell users to use journalctl instead.

Comment 4 Emma Heftman 2017-01-31 13:53:13 UTC
Uri, do (In reply to Uri Lublin from comment #3)
> (In reply to David Jaša from comment #0)
> I think David has a good point, especially as this can be done without root
> permissions.
> 
> A few comments:
> 
> > Description of problem:
> > spice-vdagent on Linux is two-part just as in Windows but documentation
> > (Administration Guide - Table 18.4) captures just system part that is
> 
> That's probably Table 19.4 here
> 
> > responsible for message passing between server (and by extension, client)
> > and per-session part.
> > 
> > To get debug output of per-session part of the agent, it has to be killed in
> > the session to be debugged and restarted in foreground with debug output on:
> > $ killall spice-vdagent
> 
> This works but
> perhaps we should come up with a command that does not try to kill other
> users processes.

Uri, which command should I use in order to not kill other users' processes?


> > $ spice-vdagent -x -d [-d] [ | tee spice-vdagent.log ]
> 
> Here it should be "|&"        ^^^
> Apparently spice-vdagent writes to stderr.
> 
> 
> In addition:
> The reference to /var/log/vdagent.log should be removed
> and instead tell users to use journalctl instead.

Comment 5 Uri Lublin 2017-02-02 14:14:55 UTC
(In reply to emma heftman from comment #4)
> (In reply to Uri Lublin from comment #3)
> > > To get debug output of per-session part of the agent, it has to be killed in
> > > the session to be debugged and restarted in foreground with debug output on:
> > > $ killall spice-vdagent
> > 
> > This works but
> > perhaps we should come up with a command that does not try to kill other
> > users processes.
> 
> Uri, which command should I use in order to not kill other users' processes?

For example:
killall -u $USER spice-vdagent

Comment 7 Emma Heftman 2017-02-06 10:51:43 UTC
Davide, please review the changes that I have made to the Administration Guide:

http://file.tlv.redhat.com/~eheftman/bz1373263/html-single/#sect-SPICE_Log_Files
Section 19.3.2