panicparse - Golang堆栈跟踪分析与可视化插件

panicparse是一个用于解析panic堆栈跟踪的工具，它能够压缩和去重具有相似堆栈跟踪的goroutine，帮助调试高度并行化进程中的崩溃和死锁问题。

主要特性

支持竞态检测器，可以解析go test -race产生的输出
支持HTML导出
可作为HTTP Handler中间件使用
高性能解析
提供HTTP web server，比net/http/pprof更易读
输出比原始堆栈转储紧凑50%以上但更易读
去重冗余的goroutine堆栈，适用于大型服务器崩溃
使用指针ID而非原始指针值作为参数
将仅包含标准库的堆栈放在底部以突出重要代码
如果源文件可用则解析源文件以增强输出
支持Go支持的所有平台，包括Windows、macOS和Linux
完整的go module支持
需要Go 1.17+版本

安装

go install github.com/maruel/panicparse/v2/cmd/pp@latest

使用示例

从其他进程管道传递堆栈跟踪

Bash v4或zsh:

go test -v |& pp

Windows或macOS原生bash:

go test -v 2>&1 | pp

Fish:

go test -v &| pp

调查死锁

在POSIX系统上，使用Ctrl-\发送SIGQUIT信号到你的进程，pp会忽略该信号并解析堆栈跟踪。

从文件解析

go test 2> stack.txt
pp stack.txt

禁用内联优化

Go工具链会在可能的情况下内联函数，这会使跟踪信息不够详细。可以使用以下方式帮助诊断问题：

go install -gcflags '-N -l' path/to/foo
foo |& pp

或

go test -gcflags '-N -l' ./... |& pp

设置GOTRACEBACK

默认情况下，GOTRACEBACK设置为single，意味着panic只会返回当前goroutine的跟踪。要获取所有goroutine的跟踪：

export GOTRACEBACK=all

或在Windows上：

set GOTRACEBACK=all

代码示例

以下是一个简单的示例，展示如何在代码中使用panicparse：

package main

import (
	"log"
	"net/http"
	"runtime"

	"github.com/maruel/panicparse/v2/stack/webstack"
)

func main() {
	// 添加webstack handler
	http.Handle("/debug/goroutines", webstack.SnapshotHandler)

	// 启动一个会panic的goroutine
	go func() {
		panic("this is a test panic")
	}()

	log.Fatal(http.ListenAndServe(":8080", nil))
}

提示

在macOS上更新bash到v4+版本，可以通过homebrew或macports安装
如果遇到/usr/bin/pp冲突，可以使用完整命令名：

go install github.com/maruel/panicparse/v2@latest
panicparse stack.txt

或者使用别名：

alias gp=panicparse
go test 2> gp

panicparse由Marc-Antoine Ruel和贡献者们开发，旨在帮助开发者更高效地分析和调试Go程序中的并发问题。

更多关于golang优化堆栈跟踪分析与可视化插件panicparse的使用的实战教程也可以访问 https://www.itying.com/category-94-b0.html

yuanlaile 1楼

更多关于golang优化堆栈跟踪分析与可视化插件panicparse的使用的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html

使用panicparse优化Golang堆栈跟踪分析与可视化

panicparse是一个强大的Golang工具，专门用于解析和可视化panic时的堆栈跟踪信息，使调试更加高效。下面我将详细介绍它的使用方法和优势。

为什么需要panicparse

标准Golang的panic堆栈跟踪存在以下问题：

冗长且难以阅读
缺少goroutine分组
没有颜色高亮
重复信息多

panicparse通过以下方式优化：

按goroutine状态分组
使用颜色高亮关键信息
压缩重复调用栈
显示goroutine创建顺序

安装panicparse

go install github.com/maruel/panicparse/v2/cmd/pp@latest

基本使用方法

1. 直接解析panic输出

go run main.go 2>&1 | pp

2. 解析保存的日志文件

pp < panic.log

3. 在代码中使用(高级用法)

import (
	"bytes"
	"os"

	"github.com/maruel/panicparse/v2/stack"
)

func parsePanic(output []byte) {
	// 创建扫描器
	s, _, err := stack.ScanSnapshot(bytes.NewReader(output), os.Stdout, stack.DefaultOpts())
	if err != nil {
		panic(err)
	}

	// 分析并输出
	buckets := stack.Aggregate(s.Goroutines, stack.AnyValue)
	stack.PrintBuckets(os.Stdout, buckets, true)
}

主要功能特性

1. Goroutine分组

panicparse会将相似的goroutine堆栈分组显示，显著减少视觉混乱。

2. 颜色编码

红色：运行中的goroutine
黄色：可运行的goroutine
蓝色：系统调用中的goroutine
绿色：等待中的goroutine

3. 调用栈压缩

相同的调用栈路径会被合并，显示调用次数。

4. 源码位置

显示每个调用点的文件和行号。

实际示例

假设有以下panic输出：

panic: runtime error: index out of range [5] with length 3

goroutine 1 [running]:
main.processData(0xc0000180a0, 0x3, 0x3)
	/path/to/file.go:15 +0x105
main.main()
	/path/to/file.go:10 +0x5a

使用panicparse后输出：

1: running [1]
    main.processData file.go:15
    main.main file.go:10
    runtime.main proc.go:255

高级配置

通过环境变量可以自定义输出：

# 禁用颜色
PP_COLORS=0 pp < panic.log

# 设置调用栈深度
PP_DEPTH=10 pp < panic.log

# 显示完整包路径
PP_FULLPATH=1 pp < panic.log

集成到测试中

可以在测试中自动使用panicparse：

func TestMain(m *testing.M) {
	// 捕获panic并格式化输出
	defer func() {
		if r := recover(); r != nil {
			// 将panic输出重定向到panicparse
			cmd := exec.Command("pp")
			cmd.Stdin = os.Stdin
			cmd.Stdout = os.Stdout
			cmd.Stderr = os.Stderr
			_ = cmd.Run()
		}
	}()
	
	os.Exit(m.Run())
}

性能分析

panicparse也可以用于分析性能profile：

go test -cpuprofile=cpu.prof -memprofile=mem.prof
pp < cpu.prof

总结

panicparse是Golang开发者工具箱中不可或缺的工具，它能：

大幅提高panic日志的可读性
快速定位问题goroutine
减少调试时间
支持多种输入源(直接输出、文件、性能profile)