panicparse
Parses and simplifies Go panic stack traces to help debug crashes and deadlocks in parallel applications.
What is panicparse?
panicparse is a Go library and command-line tool that parses panic stack traces, densifies output, and deduplicates goroutines with similar stack traces. It transforms verbose crash dumps into more readable formats, making it easier to diagnose issues in heavily concurrent Go programs.
Go developers debugging crashes, deadlocks, or race conditions in parallelized applications, especially those working with servers or tests producing large stack traces.
Developers choose panicparse for its ability to condense and deduplicate goroutine stacks, reducing noise and focusing on relevant information, with additional features like HTML export, HTTP middleware integration, and race detector support not found in standard Go tooling.
Overview
Crash your app in style (Golang)
Use Cases
Best For
- Debugging crashes in heavily concurrent Go servers with many goroutines.
- Parsing and analyzing output from `go test -race` and other race detection tools.
- Integrating readable goroutine snapshots into web applications via HTTP middleware.
- Visualizing stack traces in HTML format for better debugging clarity.
- Reducing noise in large panic dumps by deduplicating similar goroutine stacks.
- Serving compact goroutine snapshots as an alternative to `net/http/pprof` endpoints.
Not Ideal For
- Debugging non-Go applications or stack traces from other programming languages.
- Simple Go programs with few goroutines where standard panic output is sufficient.
- Teams relying exclusively on GUI debuggers or IDEs without command-line integration.
- Environments with strict security policies preventing installation of third-party CLI tools.
Pros & Cons
Pros
Parses output from `go test -race` and similar tools, simplifying race condition debugging in Go tests.
Exports stack traces to HTML for better visual clarity, aiding in sharing and analyzing complex dumps.
Provides an HTTP handler middleware for serving compact goroutine snapshots in web applications, as an alternative to net/http/pprof.
Groups similar goroutine stacks to reduce noise, making large server crash analysis more manageable.
Parses available source files to enrich stack traces with code context, enhancing debugging insight.
Cons
Requires different piping commands for bash v4, zsh, fish, and has broken support in PowerShell, complicating cross-platform usage.
Requires Go 1.17 or higher, with separate versions for older Go, which can be a hurdle for legacy projects.
Specifically designed for panic stack traces, so it doesn't handle other debugging tasks like logging or performance profiling outside panics.
Frequently Asked Questions
Related Projects
fzf:cherry_blossom: A command-line fuzzy finder
diveA tool for exploring each layer in a docker image
HubA command-line tool that makes git easier to use with GitHub.
lo💥 A Lodash-style Go library based on Go 1.18+ Generics (map, filter, contains, find...)
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.