Go Pprof Analyzer

🚀 简体中文でPProfのDockerコンテナを実行する

このプロジェクトは、PProfをDockerコンテナで実行する方法を提供し、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. 結果のエクスポート機能を追加する。