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
;
;
<+|
Example on Linux
Installation
Ubuntu Bionic [x86_64]
Please add my PackageCloud open source repository and install usereport via apt.
|
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
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.