|
|
|
|
# below
|
|
|
|
|
|
|
|
|
|
[](https://github.com/facebookincubator/below/actions?query=workflow%3ACI+branch%3Amaster+)
|
|
|
|
|
[](https://matrix.to/#/!SrWxtbLuRUMrDbftgA:matrix.org?via=matrix.org)
|
|
|
|
|
|
|
|
|
|
`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)
|
|
|
|
|
* `record` mode to record system data
|
|
|
|
|
* `replay` mode to replay historical system data
|
|
|
|
|
* `live` mode to view live system data
|
|
|
|
|
* `dump` subcommand to report script-friendly information (eg JSON and CSV)
|
|
|
|
|
|
|
|
|
|
below does **not** have support for cgroup1.
|
|
|
|
|
|
|
|
|
|
The name "below" stems from the fact that the below developers rejected many
|
|
|
|
|
of [atop](https://linux.die.net/man/1/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
|
|
|
|
|
|
|
|
|
|
`below` is packaged in Fedora as of Fedora 34, and can be installed with:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
sudo dnf install below
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Optionally, the systemd service for persistent data collection can also be
|
|
|
|
|
enabled with:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
sudo systemctl enable --now below
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Installing from source
|
|
|
|
|
|
|
|
|
|
First, install dependencies listed in [building.md](docs/building.md).
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ cargo install below
|
|
|
|
|
$ below --help
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
For convenience, we also provide a Dockerfile and
|
|
|
|
|
[pre-built images](https://hub.docker.com/r/below/below) on Docker Hub.
|
|
|
|
|
See [docker.md](docs/docker.md) for how to use them.
|
|
|
|
|
|
|
|
|
|
## Quickstart
|
|
|
|
|
|
|
|
|
|
Live view of system:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ sudo below live
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Run recording daemon:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ sudo cp ~/.cargo/bin/below /bin/below # if using cargo-install
|
|
|
|
|
$ sudo cp resctl/below/etc/below.service /etc/systemd/system
|
|
|
|
|
$ sudo systemctl daemon-reload
|
|
|
|
|
$ sudo systemctl start below
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Replay historical data:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ below replay -t "3m ago"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Comparison with alternative tools
|
|
|
|
|
|
|
|
|
|
See [comparison.md](docs/comparison.md) for a feature comparison
|
|
|
|
|
with alternative tools.
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
See [LICENSE](LICENSE) file.
|
