#diagnostics #cross-platform #cli #terminal #bugreport

bugreport

Collect system and environment information for bug reports

4 releases (2 breaking)

0.3.0 Jan 6, 2021
0.2.1 Jan 1, 2021
0.2.0 Jan 1, 2021
0.1.0 Dec 31, 2020

#176 in Command-line interface

Download history 186/week @ 2020-12-27 1387/week @ 2021-01-03 1605/week @ 2021-01-10

65 downloads per month
Used in emplace

MIT/Apache and GPL-3.0-only

21KB
506 lines

bugreport

Continuous integration Crates.io Documentation

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 may change in the future.

Example

The following code

use bugreport::{bugreport, collector::*, format::Markdown};

fn main() {
    bugreport!()
        .info(SoftwareVersion::default())
        .info(OperatingSystem::default())
        .info(CommandLine::default())
        .info(EnvironmentVariables::list(&["SHELL", "EDITOR"]))
        .info(CommandOutput::new("Python version", "python", &["-V"]))
        .info(CompileTimeInformation::default())
        .print::<Markdown>();
}

generates bug report information that looks like this.

Collectors

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

Features

  • 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

Dependencies

~0.8–1.3MB
~25K SLoC