Skip to content

Add a convenience wrapper for profiling and tracing Go tests. #2213

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 2 commits into from
Oct 2, 2025
Merged

Add a convenience wrapper for profiling and tracing Go tests. #2213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2fcb5f
Add a convenience wrapper for profiling and tracing Go tests.
matthewdale Sep 30, 2025
80c3f56
Clean up temp file after the script exits.
matthewdale Sep 30, 2025
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
35 changes: 35 additions & 0 deletions etc/profile-test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#!/usr/bin/env bash
# Convenience wrapper for profiling and tracing Go tests.
set -eu

# Create a temporary file to store the profile or trace data. Trap the exit
# signals to clean it up after the script exits (typically via Ctrl-C).
tmpfile=$(mktemp)
trap 'rm -f "$tmpfile"' EXIT INT TERM

# Set the prompt and options for the select menu.
PS3="Choose a profile type: "
options=("cpu" "mem" "block" "mutex" "trace")

select choice in "${options[@]}"
do
case $choice in
"cpu" | "mem" | "block" | "mutex")
echo "Writing $choice profile to $tmpfile"

go test -${choice}profile ${tmpfile} "$@"
go tool pprof -http=: ${tmpfile}
break
;;
"trace")
echo "Writing trace to $tmpfile"

go test -trace ${tmpfile} "$@"
go tool trace ${tmpfile}
break
;;
*)
echo "Invalid option. Please try again."
;;
esac
done
Loading