panicparse

Crash your app in style (Golang)

Subscribe to updates I use panicparse


Statistics on panicparse

Number of watchers on Github 1637
Number of open issues 7
Average time to close an issue about 2 months
Main language Go
Average time to merge a PR 1 day
Open pull requests 2+
Closed pull requests 6+
Last commit 3 months ago
Repo Created over 3 years ago
Repo Last Updated 3 months ago
Size 1.38 MB
Homepage https://maruel.ne...
Organization / Authormaruel
Latest Releasev1.1.1
Contributors3
Page Updated
Do you use panicparse? Leave a review!
View open issues (7)
View panicparse activity
View on github
Latest Open Source Launches
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating panicparse for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

panicparse

Parses panic stack traces, densifies and deduplicates goroutines with similar stack traces. Helps debugging crashes and deadlocks in heavily parallelized process.

Build Status Go Report Card

panicparse helps make sense of Go crash dumps:

Screencast

Features

  • >50% more compact output than original stack dump yet more readable.
  • Exported symbols are bold, private symbols are darker.
  • Stdlib is green, main is yellow, rest is red.
  • 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.
  • Usable as a library! GoDoc
    • Warning: please pin the major version (i.e. vendor it via dep) as breaking changes happen on major version update.
  • Parses the source files if available to augment the output.
  • Works on Windows.

Installation

go get github.com/maruel/panicparse/cmd/pp

Usage

Piping a stack trace from another process

TL;DR

  • Ubuntu (bash v4 or zsh): |&
  • OSX, install bash 4+, then: |&
  • Windows or OSX with stock bash v3: 2>&1 |
  • Fish 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 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 OSX 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. :(

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

GOTRACEBACK

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.

Updating bash on OSX

Install bash v4+ on OSX via homebrew or macports. 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 begining of $PATH or use long name panicparse with:

go get github.com/maruel/panicparse

then using panicparse instead of pp:

go test 2> panicparse
panicparse open issues Ask a question     (View All Issues)
  • almost 2 years [feature] mark stdlib entries distinctively
  • almost 2 years [feature] "vim/compiler-like format" [-format=vim? =quickfix?]
  • almost 2 years [feature] --only: show only the stacktrace lines, filter out the rest
  • almost 2 years [feature] rank "unique snowflakes" higher
  • about 3 years convert stack/stack.go to a formal state machine
panicparse open pull requests (View All Pulls)
  • basic filter implementation
  • allow matching and filtering traces
panicparse list of languages used
panicparse latest release notes
v1.1.1 vendor/ trim and update

No functional change.

  • Removed github.com/maruel/ut as a testing dependency, which trimmed the vendored tree.
  • Updated other dependencies.
v1.1.0 Features release

This is a feature release. It includes changes in the last 3 months:

  • Guess $GOROOT and $GOPATH from the stack trace, and try to match with local value.
  • New -html flag, currently rudimentary until someone who knows CSS contributes improvements. wink wink
  • Add cmd/panic, to generate various style of stack traces.
  • Silence SIGQUIT only when reading from stdin.
v1.0.2 Fix crash when parsing non-matching source files

Maintenance release.

Other projects in Go