#view #record #resource #interactive #facebook #system #data #tool #control #directories

app below

An interactive tool to view and record historical system data

1 unstable release

0.1.0 Nov 7, 2020

Apache-2.0

710KB
17K SLoC

resctl

CI Matrix chat

resctl is an umbrella repository for resource control projects at Facebook.

Projects

below

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's design and style decisions.

Demo

Comparison with alternative tools

See comparison.md for a feature comparison with alternative tools.

procfs

procfs is a rust library that parses procfs files.

cgroupfs

cgroupfs is a rust library that parses cgroup2 control files.

Installing

Live view of system:

$ podman run --privileged --cgroupns=host --pid=host -it below/below:latest

Run recording daemon:

$ sudo cp resctl/below/etc/below.service /etc/systemd/system
$ sudo systemctl daemon-reload
$ sudo systemctl start below

Replay historical data:

$ podman run --mount='type=bind,src=/var/log/below,dst=/var/log/below' -it below/below replay -t "3m ago"

See docker.md for more details.

Alternatively, see building.md for non-docker build instructions.

Contributing

See the CONTRIBUTING file for how to help out.

License

See LICENSE file.

Dependencies

~17MB
~315K SLoC