1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
# panicparse
Parses panic stack traces, densifies and deduplicates goroutines with similar
stack traces. Helps debugging crashes and deadlocks in heavily parallelized
process.
[](https://pkg.go.dev/github.com/maruel/panicparse/v2/stack)
[](https://codecov.io/gh/maruel/panicparse)
panicparse helps make sense of Go crash dumps:
## Features
* Go 1.18 stack trace support. Requires >=go1.13.
* Full go module support.
* Race detector support.
* HTML export.
* High performance parsing.
* [webstack.SnapshotHandler](https://pkg.go.dev/github.com/maruel/panicparse/v2/stack/webstack#SnapshotHandler)
is a http handler that serves a very tight and swell snapshot of your
goroutines, much more readable than
[net/http/pprof](https://golang.org/pkg/net/http/pprof).
* >50% more compact output than original stack dump yet more readable.
* Deduplicates redundant goroutine stacks. Useful for large server crashes.
* Arguments as pointer IDs instead of raw pointer values.
* Pushes stdlib-only stacks at the bottom to help focus on important code.
* Parses the source files if available to augment the output.
* Works on Windows. 🪟
## Installation
go install github.com/maruel/panicparse/v2/cmd/pp@latest
## Usage
### Piping a stack trace from another process
#### TL;DR
* Ubuntu (bash v4 or zsh): `|&`
* macOS, [install bash 4+](README.md#updating-bash-on-macos), then: `|&`
* Windows _or_ macOS with stock bash v3: `2>&1 |`
* [Fish](http://fishshell.com/) shell: `^|`
#### Longer version
`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](https://golang.org/src/runtime/panic1.go) via the native [`print()`
function](https://golang.org/pkg/builtin/#print).
**Bash v4** or **zsh**: `|&` tells the shell to redirect stderr to stdout,
it's an alias for `2>&1 |` ([bash
v4](https://www.gnu.org/software/bash/manual/bash.html#Pipelines),
[zsh](http://zsh.sourceforge.net/Doc/Release/Shell-Grammar.html#Simple-Commands-_0026-Pipelines)):
go test -v |&pp
**Windows or macOS native bash** [(which is
3.2.57)](http://meta.ath0.com/2012/02/05/apples-great-gpl-purge/): They don't
have this shortcut, so use the long form:
go test -v 2>&1 | pp
**Fish**: `&|` redirects stderr and stdout. It's an alias for `2>&1 |`
([fish piping](https://fishshell.com/docs/current/index.html#piping)):
go test -v &| pp
**PowerShell**: [It has broken `2>&1` redirection](https://connect.microsoft.com/PowerShell/feedback/details/765551/in-powershell-v3-you-cant-redirect-stderr-to-stdout-without-generating-error-records). The workaround is to shell out to cmd.exe. :(
### Investigate deadlock
On POSIX, use `Ctrl-\` to send SIGQUIT to your process, `pp` will ignore
the signal and will parse the stack trace.
### Parsing from a file
To dump to a file then parse, pass the file path of a stack trace
go test 2> stack.txt
pp stack.txt
## Tips
### Disable inlining
Starting with go1.11, the toolchain starts to inline more often. This causes
traces to be less informative. Starting with go1.17, optimization also interfere
with traces. You can use the following to help diagnosing issues:
go install -gcflags '-N -l' path/to/foo
foo |& pp
or
go test -gcflags '-N -l' ./... |& pp
Run `go tool compile -help` to get the full list of valid values for -gcflags.
### GOTRACEBACK
By default, [`GOTRACEBACK`](https://golang.org/pkg/runtime/) defaults to
`single`, which means that a panic will only return the current goroutine trace
alone. 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`.
### Updating bash on macOS
Install bash v4+ on macOS via [homebrew](http://brew.sh) or
[macports](https://www.macports.org/). Your future self will appreciate having
done that.
### If you have `/usr/bin/pp` installed
If 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 install github.com/maruel/panicparse/v2@latest
then using `panicparse` instead of `pp`:
go test 2> panicparse
Hint: You may also use shell aliases
alias gp=panicparse
go test 2> gp
alias p=panicparse
go test 2> p
### webstack in action
The
[webstack.SnapshotHandler](https://pkg.go.dev/github.com/maruel/panicparse/v2/stack/webstack#SnapshotHandler)
http.Handler enables glancing at at a snapshot of your process trivially:
## Authors
`panicparse` was created with ❤️️ and passion by [Marc-Antoine
Ruel](https://github.com/maruel) and
[friends](https://github.com/maruel/panicparse/graphs/contributors).
|
