Go Pprof Analyzer

🚀 使用簡體中文運行 PProf 的 Docker 容器

本項目提供了使用 Docker 容器運行 PProf 的方法，幫助開發者對 Go 項目進行性能剖析，通過直觀的界面和便捷的操作，快速定位性能瓶頸。

🚀 快速開始

啟動步驟

1. 拉取 PProf 鏡像

docker pull dockerhub.schaefer.name/pprof:latest-amd64

2. 創建配置文件 pprof-config.yaml

address: ":8080"
pprofs:
  - name: "Heap profile"
    pattern: ".*\.heap"
    contentTypes: ["application/octet-stream"]
    subProcessProfile: true
    type: "heap"
  - name: "CPU profile"
    pattern: ".*\.cpu"
    contentTypes: ["text/plain"]
    type: "cpu"
  - name: "Goroutine profile"
    pattern: ".*\.goroutine"
    contentTypes: ["text/plain"]
    type: "goroutine"

3. 啟動 PProf 容器

docker run -d --name pprof -p 8080:8080 -v $(pwd)/pprof-config.yaml:/etc/pprof/config.yaml dockerhub.schaefer.name/pprof:latest-amd64

4. 訪問 PProf 的 Web 界面

# 在瀏覽器訪問 http://<your-docker-host>:8080 或者 http://localhost:8080 如果在本機運行

📦 安裝指南

將項目代碼與 PProf 集成

1. 在你的 Go 項目中添加以下代碼進行性能剖析

import (
	"fmt"
	"log"
	"net/http"
	
	"github.com/google/pprof/agent"
)

func main() {
	log.Println("Starting application on port 8081")
	http.HandleFunc("/", handler)
	http.ListenAndServe(":8081", nil)
}

func handler(w http.ResponseWriter, r *http.Request) {
	if r.URL.Path == "/debug/pprof" {
		w.Header().Set("Content-Type", "application/octet-stream")
		agent.Profile(r.Context(), w, agent.MainArgs{})
		return
	}
	fmt.Fprintf(w, "Hello, World!")
}

2. 使用 curl 啟動分析

# 分析 CPU 文件
curl -X POST http://localhost:8080/pprof/upload -F "file=@./testdata/gobench.cpu"

# 開啟交互式 PProf UI（僅限 macOS）
curl -X POST http://localhost:8080/pprof/debug \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"address":"http://localhost:8081/debug/pprof/"}'

💻 使用示例

基礎用法

分析本地 CPU 剖析文件

{
	"tool_name": "analyze_pprof",
	"arguments": {
		"profile_path": "./testdata/gobench.cpu",
		"type": "cpu"
	}
}

高級用法

生成火焰圖

{
	"tool_name": "generate_flamegraph",
	"arguments": {
		"profile_path": "./testdata/gobench.cpu",
		"output_path": "./flame-graph.svg"
	}
}

📚 詳細文檔

發佈說明

版本更新日誌

v0.1.2 (2023-05-26)

• 修復了火焰圖生成中的內存洩漏問題
• 提高了剖析文件解析的效率
• 支持 goroutine 剖析的子進程模式
• 新增了基於時間戳的剖析文件命名規則

已知問題

• 不支持分析非常大的剖析文件（超過 1GB）
• 在處理某些特定類型的剖析數據時可能會出現延遲

使用說明

請確保在運行 PProf 容器之前已經拉取最新的鏡像，並正確配置您的應用程序以生成相應的剖析文件。如遇問題，請參考官方文檔或聯繫技術支持。

🔮 未來改進計劃

1. 支持更多類型的剖析文件
2. 提供基於 Web 的交互式分析界面
3. 增加對多線程和異步應用的支持
4. 優化內存使用效率
5. 新增結果導出功能