Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc : Add info about hypervisor log file locations for troubleshooting (#3688) #8

Merged

Conversation

rohanKanojia
Copy link
Contributor

Description

Related to crc-org/crc#3688

Add information about hyper-v, vfkit and libvirt virtual machine specific logs to help users find more information while troubleshooting issues.

…g (#3688)

Related to crc-org#3688

Add information about hyper-v, vfkit and libvirt virtual machine specific logs to
help users find more information while troubleshooting issues.

Signed-off-by: Rohan Kumar <[email protected]>
@gbraad gbraad merged commit be51bd7 into crc-org:main Dec 2, 2024
1 check passed
@rohanKanojia rohanKanojia deleted the pr/doc-hypervisor-serial-logs branch December 2, 2024 09:32
Comment on lines +180 to +186
- **libvirt**: In case of https://libvirt.org/kbase/debuglogs.html[libvirt], you can find the log file in `/var/log/libvirt/qemu/crc.log`
- **vfkit**: In case of https://github.com/crc-org/vfkit[vfkit], you can find log file in `~/.crc/vfkit.log`
- **hyper-v**: In case of Hyper-V, there are several options to get logs:
* **Event Logs for Hyper-V**: Go to start and open `Event Viewer`, then navigate to `Applications and Services Logs` → `Microsoft` → `Windows`. Here you should be able to find some options for `Hyper-V`,
click on `Hyper-V-VMMS` for Hyper-V Virtual Machine Management logs and `Hyper-V-Worker` for Hyper-V Worker logs.
* **VM Configuration Logs**: Each VM has a set of logs that can be found in the VM configuration folder. By default, this is located in the `C:\ProgramData\Microsoft\Windows\Hyper-V` folder. For each VM, there is a file called Virtual Machine Log File (`vmname.evtx`)
that records the events related to that particular VM.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using description lists: https://docs.asciidoctor.org/asciidoc/latest/lists/description/.

Also some suggestions for minimalism:

Suggested change
- **libvirt**: In case of https://libvirt.org/kbase/debuglogs.html[libvirt], you can find the log file in `/var/log/libvirt/qemu/crc.log`
- **vfkit**: In case of https://github.com/crc-org/vfkit[vfkit], you can find log file in `~/.crc/vfkit.log`
- **hyper-v**: In case of Hyper-V, there are several options to get logs:
* **Event Logs for Hyper-V**: Go to start and open `Event Viewer`, then navigate to `Applications and Services Logs` → `Microsoft` → `Windows`. Here you should be able to find some options for `Hyper-V`,
click on `Hyper-V-VMMS` for Hyper-V Virtual Machine Management logs and `Hyper-V-Worker` for Hyper-V Worker logs.
* **VM Configuration Logs**: Each VM has a set of logs that can be found in the VM configuration folder. By default, this is located in the `C:\ProgramData\Microsoft\Windows\Hyper-V` folder. For each VM, there is a file called Virtual Machine Log File (`vmname.evtx`)
that records the events related to that particular VM.
https://libvirt.org/kbase/debuglogs.html[libvirt]::
Find the log file in `/var/log/libvirt/qemu/crc.log`.
https://github.com/crc-org/vfkit[vfkit]::
Find the log file in `~/.crc/vfkit.log`.
Hyper-C::
Event Logs for Hyper-V:::
. Go to start and open `Event Viewer`.
. Go to `Applications and Services Logs``Microsoft``Windows`.
. Click `Hyper-V-VMMS` to view Hyper-V Virtual Machine Management logs.
. Click `Hyper-V-Worker` to view Hyper-V Worker logs.
Virtual Machine Configuration Logs:::
. Open the Hyper-V configuration directory. By default: `C:\ProgramData\Microsoft\Windows\Hyper-V`.
. In this directory, open your virtual machine log file, such as `<virtual_machine_name>.evtx`), that records the events related to your virtual machine.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for review, Let me address these in a follow up PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged now, but it is on the edge of user-facing or troubleshooting.

rohanKanojia added a commit to rohankanojia-forks/docs that referenced this pull request Dec 2, 2024
Follow up PR to crc-org#8 to address review
comment from @themr0c

Signed-off-by: Rohan Kumar <[email protected]>
rohanKanojia added a commit to rohankanojia-forks/docs that referenced this pull request Dec 2, 2024
Follow up PR to crc-org#8 to address review
comment from @themr0c

Signed-off-by: Rohan Kumar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants