docs: add an easier way to grab the system logs

This commit is contained in:
alfrix 2023-11-04 15:36:45 -03:00
parent 524d0497dd
commit cad06cbc76
2 changed files with 24 additions and 9 deletions

View File

@ -10,11 +10,6 @@ body:
This is a bug report, If you need general support, please visit us on [Discord](https://discord.klipper3d.org/) This is a bug report, If you need general support, please visit us on [Discord](https://discord.klipper3d.org/)
#### The LOG file is REQUIRED. Without the logfile your issue will be closed
if you need help to find the log file:
Read the [Documentation](https://klipperscreen.readthedocs.io/en/latest/Troubleshooting/)
#### This is an Open Source project developed voluntarily, there are no Warranties, or ETA. #### This is an Open Source project developed voluntarily, there are no Warranties, or ETA.
[License](https://github.com/KlipperScreen/KlipperScreen/blob/master/LICENSE) [License](https://github.com/KlipperScreen/KlipperScreen/blob/master/LICENSE)
@ -23,6 +18,7 @@ body:
attributes: attributes:
label: 'What happened?' label: 'What happened?'
description: A clear and concise description of what the bug is. description: A clear and concise description of what the bug is.
placeholder: Example: During a print i pressed pause and nothing happend
validations: validations:
required: true required: true
- type: textarea - type: textarea
@ -30,6 +26,7 @@ body:
attributes: attributes:
label: 'What did you expect to happen instead?' label: 'What did you expect to happen instead?'
description: A clear and concise description of what you expected to happen instead. description: A clear and concise description of what you expected to happen instead.
placeholder: Example: The printer to pause.
validations: validations:
required: true required: true
- type: textarea - type: textarea
@ -37,6 +34,7 @@ body:
attributes: attributes:
label: 'How to reproduce this bug?' label: 'How to reproduce this bug?'
description: A clear and concise description with precise steps to reproduce this bug. description: A clear and concise description with precise steps to reproduce this bug.
placeholder: Example: Press pause button and during printing.
validations: validations:
required: true required: true
- type: textarea - type: textarea
@ -44,11 +42,19 @@ body:
attributes: attributes:
label: 'Additional information:' label: 'Additional information:'
description: Any additional info, screenshots or recordings which help to describe the issue. description: Any additional info, screenshots or recordings which help to describe the issue.
placeholder: Example: hardware info or related printer config.
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:
label: Log output label: Log output
description: Please attach the FULL klipperscreen.log and if needed xorg.log or the tail of journalctl. description: Please attach the FULL klipperscreen.log and if needed xorg.log or the tail of journalctl.
placeholder: >-
#### The LOG file is REQUIRED. Without the logfile your issue will be closed
if you need help to find the log file:
Read the [Documentation](https://klipperscreen.readthedocs.io/en/latest/Troubleshooting/)
Use a Zip archive if needed
render: shell render: shell
validations: validations:
required: true required: true

View File

@ -21,20 +21,29 @@ Located at `~/printer_data/logs`or in `/tmp/` if the former doesn't exist.
## System logs ## System logs
If [KlipperScreen.log](#first-steps) doesn't exist: If [KlipperScreen.log](#first-steps) doesn't exist open a terminal in the host (typically from SSH) and
copy all the relevant logs to the folder described above that can be seen and copied from the webui:
```sh
systemctl status KlipperScreen > ~/printer_data/logs/KliperScreen_systemctl.log
journalctl -xe -u KlipperScreen > ~/printer_data/logs/KliperScreen_journalctl.log
cp /var/log/Xorg.0.log ~/printer_data/logs/KliperScreen_Xorg.log
```
Alternatively you can inspect them directly on the terminal:
```sh ```sh
systemctl status KlipperScreen systemctl status KlipperScreen
``` ```
or
```sh ```sh
journalctl -xe -u KlipperScreen journalctl -xe -u KlipperScreen
``` ```
Also the Xorg log where you can find issues with the X server:
```sh ```sh
cat /var/log/Xorg.0.log cat /var/log/Xorg.0.log
``` ```
## Screen shows console instead of KlipperScreen ## Screen shows console instead of KlipperScreen
![boot](img/troubleshooting/boot.png) ![boot](img/troubleshooting/boot.png)