デバッグとプロファイリング

// デバッグログ有効化機能をマウント
// ログレベルを制御するエンドポイントを追加
debug.MountDebugLogEnabler(mux)

// HTTPハンドラーにデバッグミドルウェアを追加
// HTTPリクエストの動的デバッグログを有効化
handler = debug.HTTP()(handler)

// gRPCサーバーにデバッグインターセプターを追加
// gRPC呼び出しの動的デバッグログを有効化
svr := grpc.NewServer(
    grpc.UnaryInterceptor(debug.UnaryServerInterceptor()))

# 詳細な調査のためにデバッグログを有効化
curl "http://localhost:8080/debug?debug-logs=on"

# 調査完了時にデバッグログを無効化
curl "http://localhost:8080/debug?debug-logs=off"

# 現在のデバッグログ状態を確認
curl "http://localhost:8080/debug"

// すべてのエンドポイントでペイロードロギングを有効化
// 分析用にリクエストとレスポンスのボディを取得
// 注：ペイロードはデバッグレベルが有効な場合のみログに記録
endpoints := genapi.NewEndpoints(svc)
endpoints.Use(debug.LogPayloads())

// 取得したペイロードを表示するデバッグログ出力の例
// デバッグログが有効な場合のみ表示
{
    "level": "debug",
    "msg": "request payload",
    "path": "/users",
    "method": "POST",
    "payload": {
        "name": "John Doe",
        "email": "[email protected]"
    }
}

# 1. 問題調査時にデバッグログを有効化
curl "http://localhost:8080/debug?debug-logs=on"

# 2. 問題を再現 - ペイロードがログに記録される
# 3. ログに記録されたペイロードを分析

# 4. 調査完了時にデバッグログを無効化
curl "http://localhost:8080/debug?debug-logs=off"

// すべてのpprofハンドラーを一度にマウント
// Goプロファイリングツールの完全なスイートを有効化
debug.MountDebugPprof(mux)

// または特定のハンドラーを個別にマウントしてより細かく制御
mux.HandleFunc("/debug/pprof/", pprof.Index)          // プロファイルインデックス
mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline) // コマンドライン
mux.HandleFunc("/debug/pprof/profile", pprof.Profile) // CPUプロファイル
mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)   // シンボル検索
mux.HandleFunc("/debug/pprof/trace", pprof.Trace)     // 実行トレース

# CPUプロファイルの収集と分析
go tool pprof http://localhost:8080/debug/pprof/profile
# CPU分析用の対話型pprofシェルが開く

# ヒープメモリ使用量の分析
go tool pprof http://localhost:8080/debug/pprof/heap
# メモリ割り当てパターンを表示

# ゴルーチンの動作調査
go tool pprof http://localhost:8080/debug/pprof/goroutine
# ゴルーチンのスタックと状態を表示

# 実行トレースの取得
curl -o trace.out http://localhost:8080/debug/pprof/trace
go tool trace trace.out
# 詳細な実行の可視化を開く

// デバッグ設定エンドポイント
// 現在のサービス設定を公開
type Config struct {
    LogLevel      string            `json:"log_level"`      // 現在のログレベル
    Features      map[string]bool   `json:"features"`       // 機能フラグの状態
    RateLimit     int              `json:"rate_limit"`      // 現在のレート制限
    Dependencies  []string         `json:"dependencies"`    // サービスの依存関係
}

func debugConfig(w http.ResponseWriter, r *http.Request) {
    cfg := Config{
        LogLevel: log.GetLevel(r.Context()),
        Features: getFeatureFlags(),
        RateLimit: getRateLimit(),
        Dependencies: getDependencies(),
    }
    
    json.NewEncoder(w).Encode(cfg)
}

// デバッグメトリクスエンドポイント
// リアルタイムのサービスメトリクスを提供
func debugMetrics(w http.ResponseWriter, r *http.Request) {
    metrics := struct {
        Goroutines  int     `json:"goroutines"`     // アクティブなゴルーチン
        Memory      uint64  `json:"memory_bytes"`    // 現在のメモリ使用量
        Uptime      int64   `json:"uptime_seconds"`  // サービスの稼働時間
        Requests    int64   `json:"total_requests"`  // リクエスト数
    }{
        Goroutines: runtime.NumGoroutine(),
        Memory:     getMemoryUsage(),
        Uptime:     getUptime(),
        Requests:   getRequestCount(),
    }
    
    json.NewEncoder(w).Encode(metrics)
}

// デバッグエンドポイントをマウント
mux.HandleFunc("/debug/config", debugConfig)
mux.HandleFunc("/debug/metrics", debugMetrics)

// メモリ統計エンドポイント
// 詳細なメモリ使用情報を提供
type MemStats struct {
    Alloc      uint64  `json:"alloc"`          // 現在割り当てられているバイト数
    TotalAlloc uint64  `json:"total_alloc"`    // 割り当てられた総バイト数
    Sys        uint64  `json:"sys"`            // システムから取得した総メモリ
    NumGC      uint32  `json:"num_gc"`         // GCサイクル数
    PauseTotalNs uint64  `json:"pause_total_ns"` // GC一時停止の合計時間
}

func debugMemory(w http.ResponseWriter, r *http.Request) {
    var m runtime.MemStats
    runtime.ReadMemStats(&m)
    
    stats := MemStats{
        Alloc:      m.Alloc,
        TotalAlloc: m.TotalAlloc,
        Sys:        m.Sys,
        NumGC:      m.NumGC,
        PauseTotalNs: m.PauseTotalNs,
    }
    
    json.NewEncoder(w).Encode(stats)
}

// テスト用の手動GCトリガー
// 本番環境では注意して使用
func debugGC(w http.ResponseWriter, r *http.Request) {
    runtime.GC()
    w.Write([]byte("GC triggered"))
}