bugreport

bugreport is a Rust library that helps application developers to automatically collect information about the system and the environment that users can send along with a bug report (similar to git bugreport or ffmpeg … -report).

Note: This library is in an early stage and the API is very likely to change.

Example

The following code ```rust use bugreport::{bugreport, collectors::*};

fn main() { bugreport!() .info(SoftwareVersion::default()) .info(OperatingSystem::default()) .info(CommandLine::default()) .info(EnvironmentVariables::list(&["SHELL", "EDITOR"])) .info(CommandOutput::new("Python version", "python", &["--version"])) .info(CompileTimeInformation::default()) .print_markdown(); } ``` generates bug report information that looks like this.

Collectors

[x] Crate information (name and version)
[x] Operating system (type, name, version)
[x] Command line (including all arguments)
[x] Environment variables (e.g. SHELL, PATH, …)
[x] File contents (e.g. config files)
[x] Command output (e.g. bash --version)
[x] Compile time information (profile, target, architecture, cpu features, etc.)
[ ] Current working directory
[ ] Date and time
[x] User defined collectors

Features

[x] Markdown export
[ ] Auto-detect --diagnostic command-line option or environment variable (like --diagnostic)
[ ] Open report output in editor (instead of printing to stdout, see git bugreport)
[ ] Ask user for permission to gather information?
[ ] Automatic anonymization of information? (e.g.: remove /home/username from paths)
[ ] JSON export (?)

Use cases / prior art

ffmpegs -report option
- Interesting: "Setting the environment variable FFREPORT to any value has the same effect."
- see also: https://ffmpeg.org/bugreports.html
git bugreport
- https://git-scm.com/docs/git-bugreport
- git version --build-options
grails bugreport
- http://docs.grails.org/3.1.1/ref/Command%20Line/bug-report.html