USE-Report

usereport gathers system performance statistics on the local host that may be used as the base information for a performance analysis following the USE methodology created by Brendan Gregg. Please see this blog post by Brendan for an introduction to USE and the statistics gathered by this tool. The usereport tool is part of my base server installation. I use it everywhere. It allows me to quickly assess several system characteristics in case of performance issues.

usereport comes with bundled configuration files for Linux and macOS, respectively, that are built into the corresponding binary. The configuration files contain a pre-defined selection of performance measurement and analysis tools. Please see the contrib directory for these configuration tools. In case of Linux, several profiles allow for statistics gathering depending on the context of your analysis, i.e., mem for virtual memory and net for network issues. With usereport you do not need to remember the exact tools and their parameters to conduct a performance analysis. Furthermore, each tool configuration contains descriptions of the output to ease interpretation of results, e.g., meaning and metrics of the gathered values, as well as links to further information.

The output format of usereport is usually Markdown or HTML for convenient reading. JSON output is also available for automatic processing, or you can define your own output format using Handlebars templates. The following screenshots present parts of the HTML output created by usereport running the net profile performance analysis on Linux -- see the full report here.

The main functionality is exposed as a Rust library to be used in your own projects at your convenience.

Command Line Tool

Help

usereport 0.1.2
Lukas Pustina <lukas@pustina.net>
Collect system information for the first 60 seconds of a performance analysis
USAGE:
    usereport [FLAGS] [OPTIONS] [+|-command]...
FLAGS:
    -d, --debug                   Activate debug mode
    -h, --help                    Prints help information
        --no-progress             Force to hide progress bar while waiting for all commands to finish
        --progress                Force to show progress bar while waiting for all commands to finish
        --show-commands           Show available commands
        --show-config             Show active config
        --show-output-template    Show active template
        --show-profiles           Show available profiles
    -V, --version                 Prints version information
OPTIONS:
    -c, --config <config>                      Configuration from file, or default if not present
    -o, --output <output>                      Output format [default: markdown]  [possible values: hbs,
                                               html, json, markdown]
        --output-template <output-template>    Set output template if output is set to "hbs"
        --parallel <parallel>                  Set number of commands to run in parallel; overrides setting from config
                                               file
    -p, --profile <profile>                    Set profile to use
        --repetitions <repetitions>            Set number of how many times to run commands in row; overrides setting
                                               from config file
ARGS:
    <+|-command>...    Add or remove commands from selected profile by prefixing the command's name with '+' or '-',
                       respectively, e.g., +uname -dmesg; you may need to use '--' to signify the end of the options

Example on Linux

usereport --profile mem --progress --repetitions 3 --output html -- +mpstat

Installation

Ubuntu Bionic [x86_64]

Please add my PackageCloud open source repository and install usereport via apt.

curl -s https://packagecloud.io/install/repositories/lukaspustina/opensource/script.deb.sh | sudo bash
sudo apt-get install usereport

Linux Binaries [x86_64]

There are binaries available at the GitHub Release Page. The binaries get compiled on Ubuntu Bionic.

From Source

Please install Rust via rustup and then run

cargo install --all-features usereport-rs

Postcardware

You're free to use usereport. If you find it useful, I would highly appreciate you sending me a postcard from your hometown mentioning how you use usereport. My work address is

Lukas Pustina
CenterDevice GmbH
Rheinwerkallee 3
53227 Bonn
Germany

Contributing

I'll be happy about suggestions and pull requests.