qubes-bugreport tool

[marmarek]

Reported by woju on 18 Sep 2014 15:28 UTC
On Thu, Sep 18, 2014 at 03:08:08PM +0000, Hakisho Nukama wrote:

Maybe we need some separate qubes-generate-report tool, that is
collecting all information useful for debugging
problems from appvms and dom0.

https://groups.google.com/forum/#!topic/qubes-users/KUwfPI7Ma1Q

Migrated-From: https://wiki.qubes-os.org/ticket/901

[marmarek]

Modified by marmarek on 10 Dec 2014 11:49 UTC

[marmarek]

Modified by marmarek on 10 Dec 2014 11:49 UTC

[Jeeppler]

Is there any specification or description around how such a tool should look like? Should it just be a CLI (command line) tool which generates debug information in a text/xml file, which then can be send via email or how should it look like?

[Jeeppler]

Is there any specification or description around how such a tool should look like? Should it just be a CLI (command line) tool which generates debug information in a text/xml file, which then can be send via email or how should it look like?

[marmarek]

Yes, something like this. It should collect:

• package versions:rpm -qa qubes-*
• related VMs info (for network problems - all NetVMs and ProxyVMs): qvm-prefs VMNAME
• package versions installed in those VMs: qvm-run -p VMNAME 'rpm -qa qubes-*' (or dpkg -l qubes-*)
• related logs from /var/log/qubes

I think it should write the file in selected VM (similar to qubes-hcl-report tool) for being attached to an email, or github issue. Later we may integrate it into Qubes Manager. The file should be easily readable for normal user, to check if no private data is being leaked.

[marmarek]

Yes, something like this. It should collect:

• package versions:rpm -qa qubes-*
• related VMs info (for network problems - all NetVMs and ProxyVMs): qvm-prefs VMNAME
• package versions installed in those VMs: qvm-run -p VMNAME 'rpm -qa qubes-*' (or dpkg -l qubes-*)
• related logs from /var/log/qubes

I think it should write the file in selected VM (similar to qubes-hcl-report tool) for being attached to an email, or github issue. Later we may integrate it into Qubes Manager. The file should be easily readable for normal user, to check if no private data is being leaked.

[Jeeppler]

The tool syntax could be something like: qubes-bug-report SRC-VMNAME REPORT-VMNAME --net
the --net to report network problems. SRC-VMNAME is the VM, which has issues. REPORT-VMNAME is the which the report should be send to.

[Jeeppler]

The tool syntax could be something like: qubes-bug-report SRC-VMNAME REPORT-VMNAME --net
the --net to report network problems. SRC-VMNAME is the VM, which has issues. REPORT-VMNAME is the which the report should be send to.

[marmarek]

I'd prefer to have --dest-vm REPORT-VMNAME (or some other option name), because later when integrating into Qubes Manager we may want to save the reportin initially in dom0, give it to the user for review and only then send to some VM.
Other than that, it's ok

[marmarek]

I'd prefer to have --dest-vm REPORT-VMNAME (or some other option name), because later when integrating into Qubes Manager we may want to save the reportin initially in dom0, give it to the user for review and only then send to some VM.
Other than that, it's ok

[Jeeppler]

In which language and version would you write this tool? Python 2.7+, Python 3+, Bash?

[Jeeppler]

In which language and version would you write this tool? Python 2.7+, Python 3+, Bash?

[marmarek]

Preferably python, either version (in case of 3, it would be first qubes
tool in python3, but that isn't anything bad).

Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?

[marmarek]

Preferably python, either version (in case of 3, it would be first qubes
tool in python3, but that isn't anything bad).

Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?

[Jeeppler]

Each qube has the following logs:

• guid.VMNAME
• pacat.VMNAME
• qubesdb.VMNAME
• qrexec.VMNAME

which one would you like to see in the bug-report? Do you want to have all information from the logs or do you want to have specific parts?

[Jeeppler]

Each qube has the following logs:

• guid.VMNAME
• pacat.VMNAME
• qubesdb.VMNAME
• qrexec.VMNAME

which one would you like to see in the bug-report? Do you want to have all information from the logs or do you want to have specific parts?

[marmarek]

All of them should be a good default. Those logs are from the most recent
VM run, so should not be that big.

Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?

[marmarek]

All of them should be a good default. Those logs are from the most recent
VM run, so should not be that big.

Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?

[Jeeppler]

Okay, I created the script. The output format is Markdown.
In which repository shall a commit (upload) the script?

[Jeeppler]

Okay, I created the script. The output format is Markdown.
In which repository shall a commit (upload) the script?

[marmarek]

I think it can go to https://github.com/qubesos/qubes-core-admin, into qvm-tools directory.

[marmarek]

I think it can go to https://github.com/qubesos/qubes-core-admin, into qvm-tools directory.

[Jeeppler]

I created a pull request QubesOS/qubes-core-admin#30 . Please review the tool. The tool is written in python3.

If you want to test it, just use qubes-dom0-update python3 in Qubes 3.1 to install Python 3.3 in Dom0.

If you have any concerns or if there are any issues please let me know, I will change the script.
The script should work with Fedora, Debian and Archlinux scripts.

I added a -p option which only prints the report to the console.

[Jeeppler]

I created a pull request QubesOS/qubes-core-admin#30 . Please review the tool. The tool is written in python3.

If you want to test it, just use qubes-dom0-update python3 in Qubes 3.1 to install Python 3.3 in Dom0.

If you have any concerns or if there are any issues please let me know, I will change the script.
The script should work with Fedora, Debian and Archlinux scripts.

I added a -p option which only prints the report to the console.