commit | 0b455829879ff3fead603220bbb4a61b7e3d9545 | [log] [tgz] |
---|---|---|
author | Marc-Antoine Ruel <maruel@gmail.com> | Sat Dec 19 00:13:56 2020 |
committer | Marc-Antoine Ruel <maruel@gmail.com> | Sat Dec 19 01:12:08 2020 |
tree | 6051dc9dba91cf5cdd0343581666b68c49e8a7c9 | |
parent | 025ad7223f74550824efd4fc0e8dab83889ed2dc [diff] |
Merge back CLI tools from v2.1.0. Confirms that it makes v1 work with go1.16. With this: go get github.com/maruel/panicparse/cmd/pp does the right thing! It leverages an updated version of cmd/ and internal/, and then uses stack@v2 instead of stack/ here. Found a way to hack my way through: - Copied .github/workflows/test.yaml from v2.1.0. - Deleted all of vendor/. It was breaking the CI tests. - Updated stack/context_test.go to make it work with go1.16. - Updated stack/context_test.go to make it work with all of vendor/ removed. - Use v2.1.0 version of the executables in cmd/ and //main.go. - Use v2.1.0 version of the internal/. - Copied stack@v2.1.0 back into vendor/github.com/maruel/panicparse/v2/stack. Since older Go versions still look into it, they are able to load v2 even if go modules are disabled.
Parses panic stack traces, densifies and deduplicates goroutines with similar stack traces. Helps debugging crashes and deadlocks in heavily parallelized process.
panicparse helps make sense of Go crash dumps:
panicparse
was created with ❤️️ and passion by Marc-Antoine Ruel and friends.
go get github.com/maruel/panicparse/cmd/pp
|&
|&
2>&1 |
^|
pp
streams its stdin to stdout as long as it doesn‘t detect any panic. panic()
and Go’s native deadlock detector print to stderr via the native print()
function.
Bash v4 or zsh: |&
tells the shell to redirect stderr to stdout, it's an alias for 2>&1 |
(bash v4, zsh):
go test -v |&pp
Windows or macOS native bash (which is 3.2.57): They don't have this shortcut, so use the long form:
go test -v 2>&1 | pp
Fish: It uses ^ for stderr redirection so the shortcut is ^|
:
go test -v ^|pp
PowerShell: It has broken 2>&1
redirection. The workaround is to shell out to cmd.exe. :(
On POSIX, use Ctrl-\
to send SIGQUIT to your process, pp
will ignore the signal and will parse the stack trace.
To dump to a file then parse, pass the file path of a stack trace
go test 2> stack.txt pp stack.txt
Starting with go1.11, the toolchain starts to inline more often. This causes traces to be less informative. You can use the following to help diagnosing issues:
go install -gcflags '-l' path/to/foo foo |& pp
or
go test -gcflags '-l' ./... |& pp
Starting with Go 1.6, GOTRACEBACK
defaults to single
instead of all
/ 1
that was used in 1.5 and before. To get all goroutines trace and not just the crashing one, set the environment variable:
export GOTRACEBACK=all
or set GOTRACEBACK=all
on Windows. Probably worth to put it in your .bashrc
.
Install bash v4+ on macOS via homebrew or macports. Your future self will appreciate having done that.
/usr/bin/pp
installedIf you try pp
for the first time and you get:
Creating tables and indexes... Done.
and/or
/usr/bin/pp5.18: No input files specified
you may be running the Perl PAR Packager instead of panicparse.
You have two choices, either you put $GOPATH/bin
at the beginning of $PATH
or use long name panicparse
with:
go get github.com/maruel/panicparse
then using panicparse
instead of pp
:
go test 2> panicparse