Repository files navigation

bpftrace is a high-level tracing language for Linux. bpftrace uses LLVM as a backend to compile scripts toeBPF-bytecode and makes use oflibbpf andbcc for interacting with the Linux BPF subsystem, as well as existing Linux tracing capabilities: kernel dynamic tracing (kprobes), user-level dynamic tracing (uprobes), tracepoints, etc. The bpftrace language is inspired by awk, C, and predecessor tracers such as DTrace and SystemTap. bpftrace was created byAlastair Robertson.

• How to Install and Build
• Manual / Reference Guide
• Tutorial
• Example One-Liners
• Videos
• Tools
• Release Schedule and Process
• Contribute
• Development
• Support
• Migration guide
• Probe types
• Plugins
• License

The following one-liners demonstrate different capabilities:

# Files opened by thread namebpftrace -e 'tracepoint:syscalls:sys_enter_open { printf("%s %s\n", comm, str(args->filename)); }'# Syscall count by thread namebpftrace -e 'tracepoint:raw_syscalls:sys_enter { @[comm] = count(); }'# Read bytes by thread name:bpftrace -e 'tracepoint:syscalls:sys_exit_read /args->ret/ { @[comm] = sum(args->ret); }'# Read size distribution by thread name:bpftrace -e 'tracepoint:syscalls:sys_exit_read { @[comm] = hist(args->ret); }'# Show per-second syscall rates:bpftrace -e 'tracepoint:raw_syscalls:sys_enter { @ = count(); } interval:s:1 { print(@); clear(@); }'# Trace disk size by PID and thread namebpftrace -e 'tracepoint:block:block_rq_issue { printf("%d %s %d\n", pid, comm, args->bytes); }'# Count page faults by thread namebpftrace -e 'software:faults:1 { @[comm] = count(); }'# Count LLC cache misses by thread name and PID (uses PMCs):bpftrace -e 'hardware:cache-misses:1000000 { @[comm, pid] = count(); }'# Profile user-level stacks at 99 Hertz for PID 189:bpftrace -e 'profile:hz:99 /pid == 189/ { @[ustack] = count(); }'# Files opened in the root cgroup-v2bpftrace -e 'tracepoint:syscalls:sys_enter_openat /cgroup == cgroupid("/sys/fs/cgroup/unified/mycg")/ { printf("%s\n", str(args->filename)); }'

More powerful scripts can easily be constructed. SeeTools for examples.

For additional help / discussion, please use ourdiscussions page.

We are also holding regularoffice hours open to the public.

See theManual for more details.

bpftrace has several plugins/definitions, integrating the syntax into your editor.

• Emacs
• Vim
• VS Code
• Bash Completion

bpftrace is a registered trademark of Alastair Robertson

The code is licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.