Awesome
<div align="center"> <p> <img width=300 src="https://github.com/facebookincubator/below/blob/main/img/below_logo_horizontal.png" align="center" alt="Below" /> </p> </div> <div align="center"> <p> <a href="https://matrix.to/#/#below:matrix.org"> <img alt="Matrix chat" src="https://img.shields.io/matrix/below:matrix.org" /> </a> <a href="https://github.com/facebookincubator/below/actions?query=workflow%3ACI+branch%3Amain+"> <img alt="CI" src="https://github.com/facebookincubator/below/workflows/CI/badge.svg" /> </a> </p> </div>below is an interactive tool to view and record historical system data. It
has support for:
- information regarding hardware resource utilization
- viewing the cgroup hierarchy
- cgroup and process information
- pressure stall information (PSI)
recordmode to record system datareplaymode to replay historical system datalivemode to view live system datadumpsubcommand to report script-friendly information (eg JSON, CSV, OpenMetrics, etc.)snapshotsubcommand to create a replayable snapshot file of historical system data
below does not have support for cgroup1.
The name "below" stems from the fact that the below developers rejected many of atop's design and style decisions.
Demo
<a href="https://asciinema.org/a/355506"> <img src="https://asciinema.org/a/355506.svg" width="500"> </a>Installing
Fedora
below is packaged in Fedora as of Fedora 34, and can be installed with:
sudo dnf install below
Optionally, the systemd service for persistent data collection can also be enabled with:
sudo systemctl enable --now below
Alpine Linux
below is packaged in Alpine Linux - it's available in (upcoming) v3.17+ and
Edge. It can be installed with:
sudo apk add below
Optionally, the OpenRC service for persistent data collection can also be enabled with:
sudo rc-service below start
sudo rc-update add below
Gentoo Linux
below is available in the
sys-process/below
package and can be installed with emerge:
sudo emerge sys-process/below
Installing from source
First, install dependencies listed in building.md.
$ cargo install below
$ below --help
For convenience, we also provide a Dockerfile and pre-built images on Docker Hub. See docker.md for how to use them.
Quickstart
Live view of system:
$ sudo below live
Run recording daemon:
$ sudo cp ~/.cargo/bin/below /bin/below # if using cargo-install
$ sudo cp etc/below.service /etc/systemd/system
$ sudo systemctl daemon-reload
$ sudo systemctl start below
Replay historical data:
$ below replay -t "3m ago"
Integration with Prometheus/Grafana
below has basic support for Prometheus/Grafana through the dump interface.
See contrib/grafana/ for more details.
Comparison with alternative tools
See comparison.md for a feature comparison with alternative tools.
Contributing
See the CONTRIBUTING file for how to help out.
License
See LICENSE file.