- Rust 95.2%
- Roff 2.4%
- C 2%
- Python 0.3%
- Dockerfile 0.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
d882321c98
Summary: When running below as an unprivileged user, reading /proc/1/ns/pid may yield an empty string due to permissions, resulting in an InvalidFileFormat error instead of an IoError. Fix below invocations as unprivileged user by ignoring InvalidFileFormat in read_all_pid_info_from_path (similar to EACCES) so that execution does not abort early when encountering an inaccessible process namespace. Pull Request resolved: https://github.com/facebookincubator/below/pull/8285 Reviewed By: brianc118 Differential Revision: D117393830 Pulled By: kev-common fbshipit-source-id: def0ff662ca4e75ff18f730602be4a414b2d8a55 |
||
| .github/workflows | ||
| below | ||
| contrib/grafana | ||
| docs | ||
| etc | ||
| img | ||
| scripts | ||
| .gitattributes | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| clippy.toml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| rustfmt.toml | ||
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
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 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
Amazon Linux
below is packaged in Amazon Linux as of AL2023.9, and can be installed with:
sudo dnf install 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.