blob: b7ecb13c6fbf052cf777308875a0615b7a085da8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
[](https://github.com/facebookincubator/below/actions?query=workflow%3ACI+branch%3Amain+)
[](https://matrix.to/#/#below: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)
* `snapshot` subcommand 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](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.
|
