Google Git
Sign in
chromium / external / github.com / maruel / panicparse / 5477587b6431f8874d90108de4acd5bbb76afeb8
commit5477587b6431f8874d90108de4acd5bbb76afeb8[log] [tgz]
authorMarc-Antoine Ruel <maruel@chromium.org>Mon May 13 13:39:34 2019
committerMarc-Antoine Ruel <maruel@chromium.org>Mon May 13 14:21:38 2019
tree284ea914bcf2ecb5da2ca8bbf224df2051f92652
parentf20d4c4d746f810c9110e21928d4135e1f2a3efa [diff]
stack: Fix unit test TestAugment on go1.11 and later

Zap out arguments expectation on go1.11 and later

Where arguments used to be listed explicitly, they are now listed as
"(...)". This broke the unit tests.

For example with "panic slice_str", go1.10.8 prints:
  GOTRACEBACK=all
  panic: ([]string) (0x499cc0,0xc42000a0e0)

  goroutine 1 [running]:
  main.panicslicestr(0xc42000a0c0, 0x1, 0x2)
  (...)

whereas on go1.11beta1 the last line is:
  main.panicslicestr(...)

So I bisected Go. In this example, Go is checked out as ~/src/golang,
~/src/golang/bin is in PATH and there's a Go installation at ~/go1.4 for
bootstrapping.

  # Testing script:
  $ cat > ~/test_golang.sh <<EOF
  #!/bin/bash
  set -eu
  cd ~/src/golang/src
  ./make.bash
  go install github.com/maruel/panicparse/cmd/panic
  panic slice_str |& egrep 'main.panicslicestr\(0x'
  EOF
  $ chmod +x ~/test_golang.sh

  # Bad commit
  $ cd ~/src/golang
  $ git merge-base go1.11beta1 origin/master
  a12c1f26e4cc602dae62ec065a237172a5b8f926
  $ git checkout a12c1f26e4cc602dae62ec065a237172a5b8f926
  # Confirm this exit 1
  $ ~/test_golang.sh

  # Good commit
  $ git merge-base go1.10 origin/master
  4c4ce3dc79fcf535045e69068b15142d8b7259cd
  $ git checkout 4c4ce3dc79fcf535045e69068b15142d8b7259cd
  # Confirm this exit 1
  $ ~/test_golang.sh

  # Bisection
  $ git bisect start a12c1f26e4cc602dae62ec065a237172a5b8f926 $ 4c4ce3dc79fcf535045e69068b15142d8b7259cd
  $ git bisect run ~/test_golang.sh
  $ git bisect reset

Also fix travis on go1.8.x, lock it to go1.8.7. This is because pcg
tries to install goimports, which cannot be built on go1.8.7 anymore.

Fixes #42
4 files changed
tree: 284ea914bcf2ecb5da2ca8bbf224df2051f92652
  1. cmd/
  2. internal/
  3. stack/
  4. vendor/
  5. .travis.yml
  6. Gopkg.lock
  7. Gopkg.toml
  8. LICENSE
  9. main.go
  10. README.md
README.md

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
  • 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