usdt

README

usdt

Introduction

usdt is a Go library for linking cilium/ebpf's Program to userspace statically defined tracepoints.

Getting started

TODO: examples

Testing

Install dev dependencies

• clang 12
• apt install systemtap-sdt-dev (Debian/Ubuntu), dnf install systemtap-sdt-devel (Fedora)
• pip install stapsdt black isort
• https://github.com/linux-usdt/libstapsdt

make -C testdata
go test -exec sudo -v ./

More links and documentation

• https://lwn.net/Articles/753601/
• https://sourceware.org/systemtap/wiki/UserSpaceProbeImplementation
• https://bpf.sh/usdt-report-doc/index.html
• https://bpf.sh/production-breakpoints-doc/index.html
• https://medium.com/sthima-insights/we-just-got-a-new-super-power-runtime-usdt-comes-to-linux-814dc47e909f
• https://github.com/goldshtn/linux-tracing-workshop/blob/master/bpf-usdt.md

License

The code and docs are released under the MIT.

Documentation

Index

• type USDT
  • func New(prog *ebpf.Program, provider, probe string, pid int) (*USDT, error)
  • func (u *USDT) Close() error

Types

type USDT

type USDT struct {
	// contains filtered or unexported fields
}

USDT is a userspace statically defined tracepoint.

func New

func New(prog *ebpf.Program, provider, probe string, pid int) (*USDT, error)

New opens an USDT for the provided provider, probe and pid and attaches it to prog.

func (*USDT) Close

func (u *USDT) Close() error

Close closes the underlying uprobe.