netdata/kernel-collector — an open-source project — sits at 67 GitHub stars. Linux Kernel eBPF Collectors
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
The respository has the following directory structure:
artifacts: directory that will have the eBPF programs when the compilation
process ends.
co-re: contains all eBPF programs that utilize eBPF CO-RE (Compile Once -
Run Everywhere) technology.
tests: contains test cases for our eBPF CO-RE programs.
docs: contains an assortment of documentation related to this repository.
includes: headers used throughout the project.
kernel: contains all eBPF programs that don't utilize eBPF CO-RE
technology; these may be considered legacy more and more as time progresses
and we shift fully to CO-RE.
kernel-patches: contains patches needed to properly compile our legacy
kernel/ eBPF programs on some kernel versions.
libbpf: this is a submodule'd fork of
netdata/libbpf which is itself a fork of
the official libbpf package, the user-space side of eBPF system calls.
tools: scripts used to verify system status before installing eBPF code.
Requirements
Packages
To compile the eBPF programs, it will be necessary to have the following
packages:
libelf headers
LLVM/Clang; this is because GCC prior to 10.0 cannot compile eBPF code.
Kernel headers
Initializing Submodules
libbpf directory is included as a git submodule and it is necessary to fetch contents with the git command below:
git submodule update --init --recursive
Generating Headers
Kernel headers can be extracted directly from the kernel source doing the
following steps (assumes your kernel source is accessible at /usr/src/linux):
cd /usr/src/linux
make defconfig
make scripts
make prepare
make headers_install
Misc
In case you are using the kernel 5.4 or newer, please comment out the
following line inside the file generated/autoconf.h:
#define CONFIG_CC_HAS_ASM_INLINE 1
Makefiles
It's also possible that you'll need to change the Makefiles in this
repository according your environment. The original files were adjusted to
compile on Slackware Linux Current.
Inside kernel/Makefile, you may need to change the following variables:
KERNELSOURCE: Where is your kernel-source? This variable was set initially
to work on Slackware, Fedora and Ubuntu.
LINUXINCLUDE: Depending on the Linux distribution, it may be necessary to
add or remove directories from this variable.
LLVM_INCLUDES: Depending on the kernel version, it may be necessary to
change this path.
Building with Docker
There are two build environments that produce different variants of libc and
the Linux Kernel.
The build environments are:
musl => Dockerfile.musl (based on Alpine 3.11)
glibc => Dockerfile.glibc.generic (based on Ubuntu 20.04)
To build for a different Kernel version rather than the default just pass the
--build-arg KERNEL_VERSION=<kernel_version> argument to the docker build.
p*.o: eBPF programs used with entry mode, this is the default mode.
r*.o: eBPF programs used with return mode.
These files have to be copied to your plugins directory, which is usually at
/usr/libexec/netdata/plugins.d/, for the collector to be able to access them.
After this you can start the new collector ebpf_program.plugin.
Releasing
To release a new version and create a Github Release:
Create a Git tag like so:
$ TAG="v0.0.1"; git tag -a -s -m "Release ${TAG}" "${TAG}" && git push origin "${TAG}"
Replace v0.0.1 with the next desired tag. SemVer is not strictly being
followed here at this time so the specific tagged versions is not so
important.
This will kick off a Github Action Workflow that will Rebuild the Netdata
eBPF Kernel Collector for all Kernel and LIBC variants, create a Github
Release and upload all assets to the release to be consumed by anyone or the
Netdata Installer.
Wait for the CD pipeline to finish in the Github Actions UI.
Review the Release, Updates Release Notes, etc in the Github Releases UI.
Push the "Publish Release" button in the Github Releases UI.
Contribution
Netdata is open-source software and we are always open for contributions that
you can give us.
If you want to contribute an eBPF program, then please be sure that your
program matches the following patterns:
Your program must run on all kernels since at least kernel 4.11.
Write some code that's responsible to measure the latency of your program.
We have the variable NETDATASEL, that selects where the functions will be
attached. Be sure that inside your code 0 is associated kretprobe, and 2 is assoacited
with kprobe.
Does netdata/kernel-collector have a project website?
No homepage URL was recorded for netdata/kernel-collector in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
Does netdata/kernel-collector have any tags?
TopGit's last sync did not record any GitHub topics for netdata/kernel-collector. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on netdata/kernel-collector?
The most recent commit recorded on netdata/kernel-collector was 14 days ago, based on the GitHub push timestamp. The repository has 14 forks — one of the better signals of community interest.
How many stars does netdata/kernel-collector have?
netdata/kernel-collector has 67 GitHub stars — refresh the page for the live number, or check github.com/netdata/kernel-collector. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is netdata/kernel-collector open source?
TopGit's metadata for netdata/kernel-collector does not record a license. Most public repositories on GitHub ARE open source, but the exact terms vary — verify by opening the LICENSE file directly.
Where do I read more about netdata/kernel-collector?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/netdata/kernel-collector is the definitive source.
Read full README in the tab above.
Want a second opinion on kernel-collector?
Ask an AI that can read this page — one click and you get its take on kernel-collector.