Skip to content

bugtool: Collect pprof CPU profile #3916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2025
Merged

bugtool: Collect pprof CPU profile #3916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/packages-e2e-tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ jobs:
- name: Test Tetragon with a different tracing-policy-dir
uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3.0.2
with:
timeout_seconds: 30
timeout_seconds: 60
max_attempts: 5
retry_wait_seconds: 5
retry_on: error
Expand All @@ -165,7 +165,7 @@ jobs:
sudo tetra status
sudo grep "tetra" /var/log/tetragon/tetragon.log
sudo tetra tracingpolicy list | grep bpf -
sudo tetra bugtool 2>&1 | grep "Successfully dumped gops pprof-heap" -
sudo tetra bugtool 2>&1 | grep "Successfully dumped gops pprof.*profile=heap" -

- name: Uninstall Tetragon Tarball
run: |
Expand Down
33 changes: 24 additions & 9 deletions pkg/bugtool/bugtool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ func (s *bugtoolInfo) addBpftoolInfo(tarWriter *tar.Writer) {
s.execCmd(tarWriter, "bpftool-cgroups.json", s.info.BpfToolPath, "cgroup", "tree", "-j")
}

func (s *bugtoolInfo) getPProf(tarWriter *tar.Writer, file string) error {
func (s *bugtoolInfo) getPProf(tarWriter *tar.Writer, file string, gopsSignal byte) error {
if s.info.GopsAddr == "" {
s.multiLog.Info("Skipping gops dump info as daemon is running without gops, use --gops-address to enable gops")
return nil
Expand All @@ -531,15 +531,15 @@ func (s *bugtoolInfo) getPProf(tarWriter *tar.Writer, file string) error {
return err
}

buf := []byte{gopssignal.HeapProfile}
buf := []byte{gopsSignal}
if _, err := conn.Write(buf); err != nil {
s.multiLog.WithField("gops-address", s.info.GopsAddr).WithError(err).Warn("Failed to send gops pprof-heap command")
s.multiLog.WithField("gops-address", s.info.GopsAddr).WithField("file", file).WithError(err).Warn("Failed to send gops pprof command")
return err
}

buff := new(bytes.Buffer)
if _, err = buff.ReadFrom(conn); err != nil {
s.multiLog.WithField("gops-address", s.info.GopsAddr).WithError(err).Warn("Failed reading gops pprof-heap response")
s.multiLog.WithField("gops-address", s.info.GopsAddr).WithField("file", file).WithError(err).Warn("Failed reading gops pprof response")
}
return s.tarAddBuff(tarWriter, file, buff)
}
Expand All @@ -566,11 +566,26 @@ func (s *bugtoolInfo) addGopsInfo(tarWriter *tar.Writer) {
s.execCmd(tarWriter, "gops.stack", s.info.GopsPath, "stack", s.info.GopsAddr)
s.execCmd(tarWriter, "gops.stats", s.info.GopsPath, "stats", s.info.GopsAddr)
s.execCmd(tarWriter, "gops.memstats", s.info.GopsPath, "memstats", s.info.GopsAddr)
err = s.getPProf(tarWriter, "gops.pprof-heap")
if err != nil {
s.multiLog.WithField("gops-address", s.info.GopsAddr).WithField("gops-path", s.info.GopsPath).WithError(err).Warn("Failed to dump gops pprof-heap")
} else {
s.multiLog.WithField("gops-address", s.info.GopsAddr).WithField("gops-path", s.info.GopsPath).Info("Successfully dumped gops pprof-heap")
profiles := map[string]byte{
"cpu": gopssignal.CPUProfile,
"heap": gopssignal.HeapProfile,
}
for name, signal := range profiles {
err = s.getPProf(tarWriter, "gops.pprof-"+name, signal)
if err != nil {
s.multiLog.
WithField("gops-address", s.info.GopsAddr).
WithField("gops-path", s.info.GopsPath).
WithField("profile", name).
WithError(err).
Warn("Failed to dump gops pprof")
} else {
s.multiLog.
WithField("gops-address", s.info.GopsAddr).
WithField("gops-path", s.info.GopsPath).
WithField("profile", name).
Info("Successfully dumped gops pprof")
}
}
}

Expand Down
Loading