Goにおける4つの診断方法#

Goには、アプリケーションのパフォーマンス問題を診断するための複数のツールが存在しています。例えば、pprof、Execution Tracer、Delveなどが挙げられます。Go Wikiの記事によると、Go において、これらのツールは以下の4グループに分類できるとされています。

graph TD
    START[パフォーマンス問題]
    START --> D1[1.Profiling]
    START --> D2[2.Tracing]
    START --> D3[3.Debugging]
    START --> D4[4.Runtime Statistics and Events]

    D1 --> P1[CPU/Heap/<br/>goroutine等]
    D2 --> P2[並行処理/<br/>タイムライン]
    D3 --> P3[Delve/<br/>GDB]
    D4 --> P4[GC統計/<br/>メモリ統計]

    style D1 fill:#f5f5f5
    style D2 fill:#f5f5f5
    style D3 fill:#f5f5f5
    style D4 fill:#f5f5f5

図1: Goにおける4つの診断方法の概要

1. Profiling（プロファイリング）#

プロファイリングカテゴリは、 コード上のホットスポットやコストを特定するのに役立つツールのカテゴリです。例えば、CPU 時間の消費量などを測定することができ、それを元にコード上のコストの高いコードや頻繁に呼び出されるコードセクションを特定することができます。このカテゴリの主要なツールとして、実行中のプログラムからプロファイルデータを収集して可視化するpprofがあります。

2. Tracing（トレース）#

トレースカテゴリは、プログラムの一連の呼び出し処理全体におけるレイテンシを分析し、各コンポーネントの寄与度を特定するのに役立つツールのカテゴリです。例えば、アプリケーション内や分散システムでの呼び出しコストの測定や、ランタイムイベント（GC、goroutine、スケジューリングなど）の詳細な動作把握をすることができます。このカテゴリの主要なツールとして、実行トレースデータを解析し、ブラウザベースのビューアで可視化するExecution Tracerがあります。

3. Debugging（デバッグ）#

デバッグカテゴリは、プログラムを一時停止し、その状態とフローを検査できるようにすることで、プログラムの動作検証やエラーの原因特定に役立つツールのカテゴリです。例えば、特定のブレークポイントで実行を停止したり、変数の値を調べたり、コールスタックをたどって関数の呼び出し履歴を確認したりすることができます。このカテゴリの主要なツールとして、GoプログラムのローカルおよびリモートデバッグをサポートするクロスプラットフォームなデバッガのDelveがあります。

# Delveでデバッグ
dlv debug main.go

# ブレークポイント設定
(dlv) break main.processRequest

# 実行
(dlv) continue

# 変数確認
(dlv) print request

4. Runtime Statistics and Events#

ランタイム統計カテゴリは、Goランタイムに関するデータの集計と分析を通じて、Goプログラムの健全性と動作に関する高レベルな概要を提供するのに役立つツールのカテゴリです。例えば、メモリの割り当て、GCの統計、goroutineの数、またはmutexの待機時間といったメトリクスを収集し、経時的な変化を監視することができます。

このカテゴリのツールとして、メトリクスを収集するための runtimeパッケージ および runtime/metricsパッケージ や、これらのデータを公開するための expvarパッケージ などがあります。

var m runtime.MemStats
runtime.ReadMemStats(&m)

// GC統計
m.NumGC           // GC実行回数
m.PauseTotal      // GC停止時間の合計
m.NextGC          // 次のGCが発動する閾値

// メモリ統計
m.Alloc           // 割り当て済みメモリ
m.TotalAlloc      // 累積割り当て量
m.HeapInuse       // 使用中のヒープ

診断方法の使い分け#

問題の種類別の選択#

公式Wikiによると、一部のツールは相互に干渉する可能性があるため、より正確な情報を得るためにツールを個別に使用することが推奨されています。

Note: Some diagnostics tools may interfere with each other. For example, precise memory profiling skews CPU profiles and goroutine blocking profiling affects scheduler trace. Use tools in isolation to get more precise info.

(訳) 一部の診断ツールは互いに干渉する可能性があります。例えば、精度の高いメモリプロファイリングはCPUプロファイルの結果を歪ませ（スキューさせ）、Goroutineのブロッキングプロファイリングはスケジューラのトレースに影響を与えます。より正確な情報を得るためには、ツールを個別に利用してください。

出典: Diagnostics - The Go Programming Language

開発フェーズ別の活用#

graph TD
    DEV[開発フェーズ]
    TEST[テストフェーズ]
    STAGING[ステージング]
    PROD[本番環境]

    DEV --> D4[Debugging<br/>ロジック検証]
    TEST --> P1[Profiling<br/>ベンチマーク]
    STAGING --> P2[Profiling<br/>負荷試験]
    STAGING --> T1[Tracing<br/>並行処理確認]
    PROD --> P3[Profiling<br/>常時監視]
    PROD --> R1[Runtime Stats<br/>メトリクス収集]
    PROD --> T2[Tracing<br/>Flight Recorder]

図2: 開発フェーズ別の診断ツール活用例

本ワークショップの焦点#

このワークショップでは、Profiling と Tracing に焦点をあてます。

graph TD
    START[パフォーマンス問題]
    START --> D1[1.Profiling]
    START --> D2[2.Tracing]
    START --> D3[3.Debugging]
    START --> D4[4.Runtime Statistics and Events]

    D1 --> P1[CPU/Heap/<br/>goroutine等]
    D2 --> P2[並行処理/<br/>タイムライン]
    D3 --> P3[Delve/<br/>GDB]
    D4 --> P4[GC統計/<br/>メモリ統計]

    style D1 fill:#e3f2fd
    style D2 fill:#e3f2fd
    style D3 fill:#f5f5f5
    style D4 fill:#f5f5f5

図3: 本ワークショップで扱う診断方法（青色でハイライト）

なぜProfilingとTracingか？#

1. 相補的な関係: ProfilingとTracingは互いに補完し合う
2. 実践的: 本番環境でも使用頻度が高い
3. 体系的な学習: 2つを比較することで、各ツールの特性を深く理解できる

次のステップ#

それでは、ProfilingとTracingの詳細を学んでいきましょう。

• Part 1: Profilingの基礎 - CPU、Heap、Goroutine、Block、Mutexプロファイリング
• Part 2: Traceの基礎 - タイムライン可視化、Task/Region、Flight Recorder

参考資料#

• Diagnostics - The Go Programming Language
• Go Performance Tuning
• Effective Go - Diagnostics