8 releases (4 breaking)

0.5.1 Jan 4, 2025
0.5.0 Apr 1, 2022
0.4.1 Jul 29, 2021
0.4.0 May 9, 2021
0.1.0 Dec 31, 2020

#67 in Command-line interface

Download history 8797/week @ 2024-12-05 6334/week @ 2024-12-12 4932/week @ 2024-12-19 4988/week @ 2024-12-26 9022/week @ 2025-01-02 10520/week @ 2025-01-09 9005/week @ 2025-01-16 7577/week @ 2025-01-23 9046/week @ 2025-01-30 10426/week @ 2025-02-06 9277/week @ 2025-02-13 11070/week @ 2025-02-20 11154/week @ 2025-02-27 13751/week @ 2025-03-06 16401/week @ 2025-03-13 13159/week @ 2025-03-20

55,873 downloads per month
Used in 28 crates (11 directly)

MIT/Apache

26KB
601 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, 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.

Dependencies

~7–330KB