Skip to content

development.md

Latest commit

 

History

History
52 lines (37 loc) · 1.31 KB

development.md

File metadata and controls

52 lines (37 loc) · 1.31 KB

Development (Linux)

This doc is for contributors.

Requirements

  • Linux kernel 5.8+
  • Root (or appropriate capabilities) to run tracers (via logirad)
  • Go 1.22+
  • clang/llvm to regenerate eBPF objects
  • libbpf development headers to build eBPF programs (e.g. libbpf-dev on Ubuntu)
  • Linux UAPI headers (if you see missing asm/types.h, install your distro's libc/kernel headers packages)

Build

make build

Generate eBPF (only needed if .o files are missing or BPF changed)

make generate

This uses bpf2go and produces trace_bpfel.o/trace_bpfeb.o plus generated Go files (exec/net/file). The BPF C inputs are named with a leading underscore (e.g. _trace.bpf.c) so go build ignores them. Commit the generated artifacts so end users do not need clang.

Tests

Unit tests:

go test ./...

Integration tests (Linux + root):

go test -tags=integration ./collector/linux -v

Troubleshooting

  • logira state directory can be overridden:
    • LOGIRA_HOME=/path/to/state
  • logirad socket can be overridden:
    • LOGIRA_SOCK=/path/to/logira.sock
  • If runtime fails to load BPF objects, set explicit paths:
    • LOGIRA_EXEC_BPF_OBJ=/abs/path/to/trace_bpfel.o
    • LOGIRA_NET_BPF_OBJ=/abs/path/to/trace_bpfel.o
    • LOGIRA_FILE_BPF_OBJ=/abs/path/to/trace_bpfel.o