PHP のプロファイルを Grafana Pyroscope で見たくてライブラリを自作した

https://fortee.jp/phperkaigi-2025/proposal/d7ad369b-b60b-4502-a958-f475e7ac876c

# 文中の参考文献
Observer API （関数フック方式）
https://www.datadoghq.com/blog/engineering/php-8-observability-baked-right-in/
Pyroscope の SDK で ptrace システムコールを使わない話
https://github.com/grafana/pyroscope/issues/216
pprof 形式について
https://github.com/DataDog/go-profiler-notes/blob/main/pprof.md
Flame Graph を使った性能改善
Beginners Guide - All About Flame Graphs Visualization | Grafanahttps://www.youtube.com/watch?v=VEvK0JkPlOY

Transcript

1. PHP のプロファイルを Grafana Pyroscope で見たくて ライブラリを自作した PHPerKaigi 2025 ぱくとま サイボウズ株式会社 Garoon開発チーム
2. オブザーバビリティの３本柱といえば？ 突然ですが、問題です 1 イントロダクション
3. オブザーバビリティの３本柱といえば？ ログ・メトリクス・トレース ですが…… オブザーバビリティの4本目の柱といえば？ 突然ですが、問題です 1 イントロダクション
4. オブザーバビリティの３本柱といえば？ ログ・メトリクス・トレース ですが…… オブザーバビリティの4本目の柱といえば？ 答えは 「継続的プロファイリング」 です。 突然ですが、問題です 1 イントロダクション
5. 継続的にプロファイルを取ることです。 継続的プロファイリングとは？ 2 イントロダクション
6. 継続的にプロファイルを取ることです。 プロファイルとは： プログラムのパフォーマンスを分析し、可視化する方法を指します。 PHPerにとっては、xdebugのプロファイル機能が馴染み深いかも。 継続的プロファイリングとは？ 2 イントロダクション
7. 継続的にプロファイルを取ることです。 継続的とは： 本番環境で、継続的にプロファイルを取り続けることを指します。 継続的プロファイリングとは？ 2 イントロダクション
8. 継続的にプロファイルを取ることです。 継続的プロファイリングとは： 本番環境で、継続的にプログラムのパフォーマンスを分析し、 可視化すること。 継続的プロファイリングとは？ 2 イントロダクション
9. • 開発環境で見つからない性能問題を発見するため • 開発環境で再現できない性能問題の原因を特定するため こんなことが解決できます 「本番環境では遅いエンドポイントが開発環境だと遅くない」 「あるユーザーだけなぜか遅い操作がある」 なぜ継続的プロファイリングが必要か？ 3 イントロダクション
10. 言語を問わないツール • New Relic • Datadog • Pyroscope PHP専用のツール • Tideways • blackfire 継続的プロファイリングを提供するツール 4 イントロダクション
11. 継続的プロファイリングはどうして「4本目の柱」なのでしょう？ 話は戻りますが……。 5 イントロダクション
12. 継続的プロファイリングはどうして「4本目の柱」なのでしょう？ A. メトリクス・ログ・トレースと組み合わせると更に強力だから！ 特にトレースと組み合わせると強力です。 話は戻りますが……。 5 イントロダクション
13. 継続的プロファイリングはどうして「4本目の柱」なのでしょう？ A. メトリクス・ログ・トレースと組み合わせると更に強力だから！ 特にトレースと組み合わせると強力です。 私「なるほど、今使っているツールと組み合わせるといいのか！」 話は戻りますが……。 5 イントロダクション
14. その時、私は Grafana を使っていました 6 イントロダクション Grafana は Pyroscope と連携できる！ Pyroscope の使い方を調べてみよう！
15. Pyroscope を PHP と連携するSDKを調べるぞ！ 7 イントロダクション
16. Pyroscope には現在 PHP用のSDK がありません 8 イントロダクション PHPはどこ！？
17. PHP のプロファイルを Grafana Pyroscope で見たくて ライブラリを自作した PHPerKaigi 2025 ぱくとま サイボウズ株式会社 Garoon開発チーム
18. 9 01 02 03 04 イントロダクション PHP プロファイラの選定 Pyroscope との連携 今後の展望 目 次 1 10 20 31
19. Pyroscope に送るプロファイルを取得する方法を考える 既存のプロファイラは取得の方法や取得するデータも多様 Pyroscope による関数の実行時間の記録に必要な • サンプリング方式 • 全てのコールスタックを取得 の条件で既存のプロファイラを比較 PHP プロファイラの選定 10 PHP プロファイラの選定
20. 4種のOSSのプロファイラを比較 • longxinH/xhprof • オリジナル xhprof の PHP8 対応版 • adsr/phpspy • reliforp/reli-prof • phpspyと似ているが、PHP 製なのでプラグインとしても利用可能 • nikic/sample_prof • コールスタックを一部しか取得しないため fork が前提 比較するプロファイラ 11 PHP プロファイラの選定
21. 各プロファイラをサンプリングのトリガー / 実行場所 の2軸で分類 プロファイラの分類 12 PHP プロファイラの選定 PHPのプロセス タイマー 外部プロセス 関数呼び出しフック xhprof sample-prof phpspy reli-prof
22. タイマー方式 別のプロセス・スレッドで時間を測り、定期的に取得 特徴：オーバーヘッドが少ない・サンプルに偏りがない 関数呼び出しフック方式 関数の開始・終了のイベントに応じて取得 特徴：PHP側のAPIを利用するため実装がシンプル サンプリングのトリガー 13 PHP プロファイラの選定
23. PHPのプロセス PHPのプラグインや拡張機能としてPHPと同じプロセスで実行 特徴：ptraceシステムコールの権限が不要 外部のプロセス 別のプロセスで実行し、ptraceシステムコールを利用して取得 特徴：オーバーヘッドが少ない・PHPと別のライフサイクルで動作 プロファイラを実行する場所 14 PHP プロファイラの選定
24. プロファイラの分類（再掲） 12 PHP プロファイラの選定 PHPのプロセス タイマー 外部プロセス 関数呼び出しフック xhprof sample-prof phpspy reli-prof タイマー方式は オーバーヘッドが小さい PHPプロセスで実行すると 利用する権限が少ない 外部プロセスは オーバーヘッドが小さい フック方式は 実装がシンプル
25. プロファイラの使い勝手 フック方式は実装がシンプルなのでライブラリとして使いやすい 外部プロセス方式は権限や外部プロセスの管理面で不利 性能へのオーバーヘッド タイマー方式のトリガー・外部プロセスでの実行が有利 → 性能への影響はどの程度？ 各方式を比較する2つの観点 15 PHP プロファイラの選定
26. 測定対象 検証の再現性を確保するために private-isu を利用 • stefafafan/private-isu-php（高パフォーマンスなPHP実装） • catatsuy/private-isu (環境設定・ベンチマーカー) 測定方法 プロファイル測定時のベンチマーク結果を比較（5回の平均） サンプリング頻度は 100Hz (10 ms) ベンチマーク 16 PHP プロファイラの選定
27. 240000 250000 260000 270000 280000 290000 300000 310000 320000 プロファイラなし phpspy sample_prof reli-prof xhprof 各プロファイラを有効にした際の private-isu のスコア ベンチマーク結果 17 PHP プロファイラの選定
28. 240000 250000 260000 270000 280000 290000 300000 310000 320000 プロファイラなし phpspy sample_prof reli-prof xhprof 各プロファイラを有効にした際の private-isu のスコア さらに低下 （-40000点程度） ベンチマーク結果 17 PHP プロファイラの選定 変化なし すこし低下 （-10000点程度）
29. プロファイラの使い勝手 xhprof が使いやすく、コンテナにも対応する 性能へのオーバーヘッド phpspy が最も小さく、次点で sample_prof まずは xhprof を採用、sample_prof を今後検討 PHP プロファイラの選定のまとめ 18 PHP プロファイラの選定
30. 19 01 02 03 04 イントロダクション PHP プロファイラの選定 Pyroscope との連携 今後の展望 目 次 1 10 20 31
31. pprof 形式 Go などで利用されている pprof 形式で受信 Pyroscope SDK で利用されている、メタデータを付与しやすい テキスト形式 単純なテキストで受信 仕様が単純すぎて、利用できる機能が限られる Pyroscope のプロファイル受信方法 20 Pyroscope との連携
32. pprof とは Google 製のプロファイル取得ツール。Go 言語製。 pprof 形式とは pprof が出力する protobuf 形式のバイナリ pprof 以外にも幅広くプロファイルの転送に利用される pprof とは？ pprof 形式とは？ 21 Pyroscope との連携
33. Pyroscope の SDK は pprof 形式で通信している つまり、pprof 形式で通信すれば他言語と同じ機能が使えるはず pprof 形式は gzip 圧縮された protobuf らしいので、 他言語の Pyroscope SDK からデータを横取りして見てみる pprof 形式の出力を見てみよう 22 Pyroscope との連携
34. pprof 形式は単なる protobuf だと最初は思っていたが、 protobuf をデコードすると謎の数値が出現した ただの protobuf じゃないぞ！？ 23 Pyroscope との連携 sample { location_id: 1 location_id: 2 location_id: 3 location_id: 4 location_id: 5 location_id: 5 location_id: 6 location_id: 7 location_id: 5 location_id: 8 location_id: 9 location_id: 10 value: 10000000 label { key: 14 str: 15 } } location { id: 1 line { function_id: 1 } } function { id: 8 name: 7 filename: 12 start_line: 207 } スタックトレースはどこに！？
35. 非常に複雑な pprof 形式 24 Pyroscope との連携 https://github.com/DataDog/go-profiler-notes/blob/main/pprof.md より 謎の数値はポインタ 例：location_id: 1 → location の id=1 を参照 プロファイルを小さくするため 複数回出現するデータを全て id で持つ
36. 大量のプロファイルをなるべく圧縮して送るためのフォーマット → 人間が読むように作られていない 人間が読みやすい出力をするツールも見当たらない Pyroscope が解釈する pprof データのドキュメントがない Pyroscope SDK が出力する pprof の出力を読むしかない → 読まなきゃいけない！ 読めないものを読もうとして 25 Pyroscope との連携
37. pprof の出力を読むために pprof デコーダを実装 26 Pyroscope との連携 { "location": [ { "mapping": null, "address": 0, "line": [ { "function": { "name": "execute", "system_name": "", "filename": "", "start_line": 0 }, "line": 0 } ], "is_folded": false }, ..., ], "value": [ 10000000 ], "label": [ { "key": "xhprof_info", "str": "SELECT `id`, `user_id`, `body`, `mime`, `created_at`...", "num": 0, "num_unit": "" } ] } sample { location_id: 1 location_id: 2 location_id: 3 location_id: 4 location_id: 5 location_id: 5 location_id: 6 location_id: 7 location_id: 5 location_id: 8 location_id: 9 location_id: 10 value: 10000000 label { key: 14 str: 15 } }
38. 出力を読むことで、Pyroscope が受け取るデータがはっきりした xhprof の出力を pprof 形式に変換するエンコーダーを作るだけ！ データの送り方 PHPアプリケーションに /debug/pprof エンドポイントを用意 → Pyroscope が勝手に pull してくれる pprof 形式が理解できるようになった 27 Pyroscope との連携
39. Pyroscope との連携の全体図 27 Pyroscope との連携 nginx Pyroscope ユーザー /index.php index.php pprof.php /debug/pprof xhprof プロファイル取得 保存 プロファイル データ 読み取り・変換 ユーザーからの アクセス Pyroscope への プロファイル送信
40. Pyroscope にプロファイルが送信できた！ 28 Pyroscope との連携
41. 送信方法 プロファイラの出力を pprof 形式に変換する必要がある pprof 形式への変換 非常に複雑なので、デコーダがあるとエンコーダも作りやすい Pyroscope との連携のまとめ 29 Pyroscope との連携
42. 30 01 02 03 04 イントロダクション PHP プロファイラの選定 Pyroscope との連携 今後の展望 目 次 1 10 20 31
43. ISUCON の本番でプロファイルを取れればそれで良い • README.md もなし • サンプルもなし • 動作確認も最低限 というか、そのうち Pyroscope が PHP 対応すると思っていた 元々 ISUCON のために作成した 31 今後の展望
44. Ruby や Python は作るのに PHP は作らない事情は色々ありそう • Rust 製の rbspy や pyspy と違って phpspy は C言語製 • PHP は CGI モデルなので他言語とライフサイクルが違う コミュニティ実装がいくつか現れて、戦国時代に突入 • zoonru/pyrospy • everythings-gonna-be-alright/phpScope Grafana が全然作ってくれないんだけど！？ 32 今後の展望
45. pakutoma/phreakscope Pyroscope 非公式 PHP 向け言語 SDK • 名前の由来：phreak（電話網のhacking）から • Pyroscope に「ただ乗り」するので 特徴 • プラグインとして動作するため、コンテナで動かしやすい 戦国時代に名乗りを上げたい 33 今後の展望
46. • Pyroscope の新機能に追従 • Trace to Profiles • Grafana Alloy の Push API • パフォーマンスの向上 • nikic/sample-prof を試す • ドキュメントを充実させる 今後の実装予定 34 今後の展望 https://grafana.com/docs/grafana-cloud/whats- new/2024-01-03-trace-to-profiles/ より
47. • Grafana Pyroscope で継続的プロファイリングがしたい • でも Pyroscope は PHP に対応していません • なので、phreakscope というライブラリを作りました • ただいま絶賛開発中です ありがとうございました！ 全体のまとめ 35 まとめ
48. Observer API （関数フック方式） https://www.datadoghq.com/blog/engineering/php-8-observability-baked-right-in/ Pyroscope の SDK で ptrace システムコールを使わない話 https://github.com/grafana/pyroscope/issues/216 pprof 形式について https://github.com/DataDog/go-profiler-notes/blob/main/pprof.md Flame Graph を使った性能改善 Beginners Guide - All About Flame Graphs Visualization | Grafana https://www.youtube.com/watch?v=VEvK0JkPlOY さらに詳しく知りたい時の資料 36 おまけ