Bug 1386096 - [Admin] Log file locations must be verified.
Summary: [Admin] Log file locations must be verified.
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.2.3
Hardware: Unspecified
OS: Unspecified
medium
low
Target Milestone: ovirt-4.2.5
: ---
Assignee: Emma Heftman
QA Contact: Megan Lewis
URL:
Whiteboard: docs-accepted
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-10-18 06:59 UTC by Zac Dover
Modified: 2019-05-07 12:45 UTC (History)
9 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-07-29 07:04:03 UTC
oVirt Team: Docs
Target Upstream Version:
eheftman: needinfo-


Attachments (Terms of Use)

Description Zac Dover 2016-10-18 06:59:58 UTC
from https://bugzilla.redhat.com/show_bug.cgi?id=1317513 :

* Verify that the log file locations in '17.4. Red Hat Enterprise
> Virtualization Host Log Files' are correct. No such log files when tested
> against vdsm-4.17.14-0.el7ev.noarch.


Summary:

The following table is, as of 18 Oct 2016, incorrect:

 ⁠19.4. Red Hat Virtualization Host Log Files
⁠

Table 19.5. 
Log File 	Description
/var/log/vdsm/libvirt.log 	Log file for libvirt.
/var/log/vdsm/spm-lock.log 	Log file detailing the host's ability to obtain a lease on the Storage Pool Manager role. The log details when the host has acquired, released, renewed, or failed to renew the lease.
/var/log/vdsm/vdsm.log 	Log file for VDSM, the Manager's agent on the virtualization host(s).
/tmp/ovirt-host-deploy-@DATE@.log 	Host deployment log, copied to engine as /var/log/ovirt-engine/host-deploy/ovirt-@DATE@-@HOST@-@CORRELATION_ID@.log after the host has been successfully deployed. 


This table should be removed from the Admin Guide, and it should be replaced with a table that has the correct log locations in it.

Comment 1 Yaniv Lavi 2016-11-01 13:23:29 UTC
Can you provide the correct log locations?

Comment 2 Yaniv Bronhaim 2016-11-02 06:37:22 UTC
 - /var/log/vdsm/libvirt.log 	Log file for libvirt.

Not correct - we use default libvirt configuration which direct the log to syslog

 - /var/log/vdsm/spm-lock.log 	
 - /var/log/vdsm/vdsm.log

Those are the same. But there is also /var/log/vdsm/supervdsm.log\Mom.log\connectivity.log\upgrade.log that we might need to document as well.

 - /tmp/ovirt-host-deploy-@DATE@.log 	Host deployment log, copied to engine as /var/log/ovirt-engine/host-deploy/ovirt-@DATE@-@HOST@-@CORRELATION_ID@.log after the host has been successfully deployed. 

Also correct.

Comment 3 Lucy Bopf 2017-05-25 04:31:34 UTC
Moving back to NEW to be reassigned as resources allow.

Comment 4 Emma Heftman 2018-07-04 12:55:28 UTC
Hi Dan
Can you please verify and where necessary update the log files detailed in this section.

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html-single/administration_guide/#Setting_up_a_Host_Logging_Server

Thanks!

Comment 5 Lucy Bopf 2018-07-13 00:14:56 UTC
Moving version over to 4.2, and untargeting pending answer to comment 4.

Comment 6 Dan Kenigsberg 2018-07-13 23:29:53 UTC
Miguel, can you verify the doc's content?

Comment 7 Miguel Duarte Barroso 2018-07-17 07:48:35 UTC
Regarding host logging - e.g. [1]:

As Yaniv already mentioned in [2], the following logs are missing
from the docs:
  - supervdsm.log -> /var/log/vdsm/supervdsm.log
  - mom.log       -> /var/log/vdsm/mom.log
  - upgrade.log   -> /var/log/upgrade.log

Furthermore, the ovn-controller logs (host logs) are also relevant.
Those are located at:
  - /var/log/openvswitch/ovn-controller.log

Regarding manager logging - e.g. [3]:

The ovirt-provider-ovn logs should also be referenced. Those are located at:
  - /var/log/ovn-provider/ovirt-provider-ovn.log

Also, the ovn-north logs could also be of interest:
  - /var/log/openvswitch/ovn-northd.log


[1] - https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html-single/administration_guide/#Host_Log_Files
[2] - https://bugzilla.redhat.com/show_bug.cgi?id=1386096#c2
[3] - https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html-single/administration_guide/#Manager_Log_Files

Comment 8 Emma Heftman 2018-07-17 13:52:05 UTC
(In reply to Miguel Duarte Barroso from comment #7)
> Regarding host logging - e.g. [1]:
> 
> As Yaniv already mentioned in [2], the following logs are missing
> from the docs:
>   - supervdsm.log -> /var/log/vdsm/supervdsm.log
>   - mom.log       -> /var/log/vdsm/mom.log
>   - upgrade.log   -> /var/log/upgrade.log
> 
> Furthermore, the ovn-controller logs (host logs) are also relevant.
> Those are located at:
>   - /var/log/openvswitch/ovn-controller.log
> 
> Regarding manager logging - e.g. [3]:
> 
> The ovirt-provider-ovn logs should also be referenced. Those are located at:
>   - /var/log/ovn-provider/ovirt-provider-ovn.log
> 
> Also, the ovn-north logs could also be of interest:
>   - /var/log/openvswitch/ovn-northd.log
> 
> 
> [1] -
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> html-single/administration_guide/#Host_Log_Files
> [2] - https://bugzilla.redhat.com/show_bug.cgi?id=1386096#c2
> [3] -
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> html-single/administration_guide/#Manager_Log_Files

Thanks Miguel, currently the docs don't mention anything about syslog, except for setting up a central logging server.
Where are the host's syslog files located?

Comment 9 Miguel Duarte Barroso 2018-07-18 09:45:31 UTC
I've made a mistake in comment #7:
The correct path for 'upgrade.log' is in /var/log/vdsm/upgrade.log

Regarding Emma's question on comment #8:
The default location for the hosts's syslog is /var/log/messages, but I think the recommended way of interacting with syslog is through the journal - journalctl

Comment 10 Emma Heftman 2018-07-18 13:04:12 UTC
(In reply to Miguel Duarte Barroso from comment #9)
> I've made a mistake in comment #7:
> The correct path for 'upgrade.log' is in /var/log/vdsm/upgrade.log
> 
> Regarding Emma's question on comment #8:
> The default location for the hosts's syslog is /var/log/messages, but I
> think the recommended way of interacting with syslog is through the journal
> - journalctl

Thanks Miguel. Should journalctl always be run as root user?

Comment 11 Emma Heftman 2018-07-18 13:31:20 UTC
Miguel. Could you provide a short description for:

- supervdsm.log 
 - mom.log      
  - upgrade.log

Comment 12 Miguel Duarte Barroso 2018-07-20 11:55:00 UTC
comment#10 : 
  - Every user gets access to its 'portion' of the journal. To get access to the system-wide journal, the user will need to feature in *any* of the following groups:
    - adm
    - systemd-journal
    - wheel

comment#11 :
  - supervdsm: log file for supervdsm (e.g. executes vdsm tasks that require superuser permissions)
  - mom: log file for vdsm's memory overcommitment manager.
  - upgrade: log file for one time scripted executions before startup of the vdsm services

@Dan, I can't be 100% of my description of the upgrade log file; can you confirm / improve the description ?

Comment 13 Dan Kenigsberg 2018-07-23 11:00:25 UTC
In some cases, when vdsm is upgraded it can find that the state of the host is not up-to-date to its existing assumption. the state of the host (mostly content of /var/lib/vdsm) is upgraded, and the upgrade log is used.

Comment 14 Emma Heftman 2018-07-23 12:29:36 UTC
(In reply to Dan Kenigsberg from comment #13)
> In some cases, when vdsm is upgraded it can find that the state of the host
> is not up-to-date to its existing assumption. the state of the host (mostly
> content of /var/lib/vdsm) is upgraded, and the upgrade log is used.

Is this what you mean?
During host upgrades, if the contents of _/var/lib/vdsm_ are out-of-date, the pre-upgrade state will be logged in 'upgrade.log'.

Comment 15 Emma Heftman 2018-07-24 10:27:05 UTC
Hey Miguel. Could you please add a couple of sentences about what each of these files contain?
/var/log/ovn-provider/ovirt-provider-ovn.log

/var/log/openvswitch/ovn-northd.log

Comment 16 Emma Heftman 2018-07-24 12:03:35 UTC
(In reply to Emma Heftman from comment #15)
> Hey Miguel. Could you please add a couple of sentences about what each of
> these files contain?
> /var/log/ovn-provider/ovirt-provider-ovn.log
> 
> /var/log/openvswitch/ovn-northd.log

I went ahead and wrote some discriptions. Can you pls review the changes to the manager's logs topic - 2 new log files at the end:

http://file.tlv.redhat.com/~eheftman/bz1386096/html-single/#Manager_Log_Files

and the hosts topic:

http://file.tlv.redhat.com/~eheftman/bz1386096/html-single/#Host_Log_Files

Comment 17 Miguel Duarte Barroso 2018-07-24 12:45:45 UTC
Looks good to me, but I can't help but wonder if the reader won't get confused by the ovn-northd (in manager) and ovn-controller logs - not sure if they were mentioned anywhere throughout the docs.

@marcin: what's your opinion on this? should the ovn-northd / ovn-controller logs appear in the RHV documentation?

Comment 18 Marcin Mirecki 2018-07-26 09:08:53 UTC
No
I would redirect to ovs/ovn docs.

> /var/log/ovn-provider/ovirt-provider-ovn.log
This is the ovirt-provider-ovn log. This should be included in our docs


> /var/log/openvswitch/ovn-northd.log
This and others in "/var/log/openvswitch" are NOT ours, they belong to openvswtich. We use it, but I don't think we should describe it, just like we don't describe other dependencies.

Maybe instead of describing them we could add something like:
"Information related to ovn/ovn can be found in their relevant logs. Please refer to the openvswitch documentation (www.openvswitch.org) for more information"

Comment 21 Emma Heftman 2018-07-29 07:04:03 UTC
The updated information is available in the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html-single/administration_guide/index#Host_Log_Files


Note You need to log in before you can comment on or make changes to this bug.