Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Netflix/bpftop
bpftop provides a dynamic real-time view of running eBPF programs. It displays the average runtime, events per second, and estimated total CPU % for each program.
https://github.com/Netflix/bpftop
Last synced: 5 days ago
JSON representation
bpftop provides a dynamic real-time view of running eBPF programs. It displays the average runtime, events per second, and estimated total CPU % for each program.
- Host: GitHub
- URL: https://github.com/Netflix/bpftop
- Owner: Netflix
- License: apache-2.0
- Created: 2024-02-10T22:20:51.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-08T00:51:18.000Z (7 months ago)
- Last Synced: 2024-04-14T09:07:39.849Z (7 months ago)
- Language: Rust
- Size: 1.82 MB
- Stars: 1,811
- Watchers: 143
- Forks: 78
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-tools - bpftop - time view of running eBPF programs. (System Monitor)
- awesome-repositories - Netflix/bpftop - bpftop provides a dynamic real-time view of running eBPF programs. It displays the average runtime, events per second, and estimated total CPU % for each program. (C)
- awesome-ratatui - bpftop - Dynamic real-time view of running eBPF programs. (💻 Apps / 👨💻 System Administration)
README
# bpftop
`bpftop` provides a dynamic real-time view of running eBPF programs. It displays the average runtime, events per second, and estimated total CPU % for each program. It also provides graphical views of these statistics over time. This tool minimizes overhead by enabling performance statistics only while it is active.
## Installation
To download the latest x86_64 release of `bpftop`, use the following command:
```bash
curl -fLJ https://github.com/Netflix/bpftop/releases/latest/download/bpftop-x86_64-unknown-linux-gnu -o bpftop && chmod +x bpftop
```
or install via your distribution's package manager:
[](https://repology.org/project/bpftop/versions)
### Fedora
You can install `bpftop` from the [official repositories](https://src.fedoraproject.org/rpms/bpftop) using [dnf](https://dnf.readthedocs.io/en/latest/):
```bash
sudo dnf install bpftop
```
### Arch Linux
You can install `bpftop` from the [official repositories](https://packages.fedoraproject.org/pkgs/bpftop/bpftop/) using [pacman](https://wiki.archlinux.org/title/pacman):
```bash
sudo pacman -S bpftop
```
### Nix
You can install bpftop from the NixOS 24.05 stable channel:
```
nix-channel --add https://nixos.org/channels/nixos-24.05 nixpkgs
nix-channel --update
nix-env -iA nixpkgs.bpftop
```
## Features
- Displays a list of all running eBPF programs on the host, including the ID, type, and name
- Shows the period and total average runtime for each eBPF program.
- Calculates the events per second and estimated CPU utilization for each eBPF program
- Provides a graphical view of the average runtime, events per second, and estimated CPU utilization over a 10-second time period
- Dynamically updates the list every second
- Enables the statistics-gathering function only while it is active
## Prerequisites
- `bpftop` requires `sudo` privileges to run.
- The binary is dynamically linked to `libz` and `libelf`, so these libraries must be present on the systems where you intend to run `bpftop`.
## Usage
Run the following command to start `bpftop` on your host:
```bash
sudo ./bpftop
```
## Relate links
* [Announcement blog post](https://netflixtechblog.com/announcing-bpftop-streamlining-ebpf-performance-optimization-6a727c1ae2e5)
* [LWN.net](https://lwn.net/Articles/963767/)
* [The New Stack](https://thenewstack.io/netflix-releases-bpftop-an-ebpf-based-application-monitor/)
## How it works
`bpftop` uses the [BPF_ENABLE_STATS](https://elixir.bootlin.com/linux/v6.6.16/source/include/uapi/linux/bpf.h#L792) BPF syscall command to enable global eBPF runtime statistics gathering, which is disabled by default to reduce performance overhead. It collects these statistics every second, calculating the average runtime, events per second, and estimated CPU utilization for each eBPF program within that sample period. This information is displayed in a top-like tabular format. Once `bpftop` terminates, it disables the statistics-gathering function by deleting the file descriptor returned by `BPF_ENABLE_STATS`.
## Building from source
1. Install and setup [cross](https://github.com/cross-rs/cross)
2. Run `cross build --release` for x86_64
3. Run `cross build --target=aarch64-unknown-linux-gnu --release` for Arm64