bugreport

Crates.iobugreport
lib.rsbugreport
version
sourcesrc
created_at2020-12-31 17:13:36.438523+00
updated_at2025-01-04 09:21:53.665364+00
descriptionCollect system and environment information for bug reports
homepagehttps://github.com/sharkdp/bugreport
repositoryhttps://github.com/sharkdp/bugreport
max_upload_size
id329794
Cargo.toml error:TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
David Peter (sharkdp)

documentation

README

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, version, git hash)
  • Operating system (type, name, version)
  • Command line (including all arguments)
  • Environment variables (e.g. SHELL, PATH, …)
  • File contents (e.g. config files)
  • Directory contents
  • 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
  • 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

Related crates

Other crates that might be useful:

  • human-panic - Make panic messages nice for humans to read.
Commit count: 111

cargo fmt