PHP-FPMのみでメトリクスを出力してみたので, その設定例と落とし穴, 外部ツールを使う場合との違いについてお話しします！

Transcript

1. PHP-FPMのみでメトリクスを出⼒してみたので， その設定例と落とし⽳, 外部ツールを使う場合との違いについて お話しします︕ PHPカンファレンス広島 森脇⼤智 話す内容は 記事でも公開中
2. l森脇 ⼤智 @daichi_164237 lサイボウズで中堅・⼤規模組織向けグループウェア Garoon（ガルーン）というWebサービスを作ってる lアボカド 【 ⾃⼰紹介 🥑 】
3. ところで, 皆さん︕
4. PHP-FPMを使ったWebサービスで, 「応答が遅くなった」, 「突然繋がらなくなった」, という経験はありませんか︖
5. PHP-FPMを使ったWebサービスで, 「応答が遅くなった」, 「突然繋がらなくなった」, という経験はありませんか︖ 👉 これら問題の原因究明や解決には, PHP-FPMのメトリクスが役に⽴つ︕
6. …らしいのですが ︕︖︕︖
7. 調べてみたところ, 取得⽅法やWebシステムを構築する環境次第で 取得できるメトリクスに違いがある ことがわかった︕
8. という訳で本発表では…
9. 【 対象 🎯 】 PHP-FPM のメトリクスをまだ取っていない⽅ 【 ゴール 🏁 】 取得できるメトリクスの違いを⼤まかにでも把握してもらうことで, メトリクスを取得する際の判断材料の1つにしてもらう
10. l PHP-FPMのメトリクスの取得⽅法 l 遭遇した落とし⽳ l 外部ツールとの⽐較 l メトリクスを取ってみた感想 l 最後に 【 アジェンダ 】
11. l PHP-FPMのメトリクスの取得⽅法 l 遭遇した落とし⽳ l 外部ツールとの⽐較 l メトリクスを取ってみた感想 l 最後に 【 アジェンダ 】
12. l PHP-FPMからOpenMetrics形式で メトリクスを取得する⽅法 l データ形式を変換する外部ツールを⽤いる⽅法 メトリクスの取得⽅法には 2種類の⽅法があることがわかった
13. メトリクスの取得⽅法には 2種類の⽅法があることがわかった 👉 今回のお話では前者の⽅法をメインにお話しします︕ l PHP-FPMからOpenMetrics形式で メトリクスを取得する⽅法 l データ形式を変換する外部ツールを⽤いる⽅法
14. 「PHP-FPMからOpenMetrics形式で メトリクスを取得する⽅法」 とは︖
15. 元々, PHP-FPMには, FPMの情報ページという, FPMの状態を出⼒できる仕組みがあります 画像の引⽤元: https://www.php.net/manual/ja/fpm.status.php
16. この情報ページが, PHP 8.1からは OpenMetrics形式でも出⼒できるようになった 🧐 OpenMetrics形式とは︖ メトリクスを送信する際のデータの仕様のこと. 多くの監視ツールがこの仕様に対応しています.
17. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
18. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
19. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
20. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
21. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
22. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
23. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
24. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
25. つまり, 以下のようにすることで データ形式を変換する外部ツールを使わずにメトリクスの取得が可能︕ PHP-FPM Webサーバー OpenMertics形式に対応した 監視ツール Scrape php-fpm:9001/metrics?openmetrics localhost:8001/metrics 設定を編集 メトリクス⽤のエンドポイントを公開 メトリクスの出⼒⾃体は, PHP-FPMのみで完結しますが, メトリクスを収集する際には, FastCGI形式からHTTP形式に変換する必要があるため Webサーバーを経由する必要があります.
26. 【 この⽅法で取得できたメトリクスの⼀覧 】 l phpfpm_up l PHP-FPM上で動的プロセス管理（dynamic PM）を使⽤したwwwプールに到達できますか︖ l phpfpm_total_processes l アクティブプロセスとアイドルプロセスの数 l phpfpm_active_processes l アクティブプロセスの数 l phpfpm_idle_processes l アイドルプロセスの数 l phpfpm_max_active_processes l FPMの起動以降にアクティブになったプロセスの最⼤数 l phpfpm_max_children_reached l プロセス制限に達した回数（pmがさらに⼦プロセスを起動しようとする際に発⽣） l （pm 『dynamic』 および 『ondemand』 でのみ有効） l phpfpm_start_since l FPMが起動してから経過した秒数 l phpfpm_listen_queue l 待機接続キュー内のリクエスト数 l phpfpm_max_listen_queue l FPMの起動以降、保留中の接続キューに蓄積されたリクエストの最⼤数 l phpfpm_listen_queue_length l 待機接続のソケットキューのサイズ l phpfpm_slow_requests l 『request_slowlog_timeout』 値を超えたリクエストの数 l phpfpm_accepted_connections l プールが受け付けたリクエストの数 l phpfpm_memory_peak l FPMが開始されてからのメモリ使⽤量のピーク値
27. 【 この⽅法で取得できたメトリクスの⼀覧 】 l phpfpm_up l PHP-FPM上で動的プロセス管理（dynamic PM）を使⽤したwwwプールに到達できますか︖ l phpfpm_total_processes l アクティブプロセスとアイドルプロセスの数 l phpfpm_active_processes l アクティブプロセスの数 l phpfpm_idle_processes l アイドルプロセスの数 l phpfpm_max_active_processes l FPMの起動以降にアクティブになったプロセスの最⼤数 l phpfpm_max_children_reached l プロセス制限に達した回数（pmがさらに⼦プロセスを起動しようとする際に発⽣） l （pm 『dynamic』 および 『ondemand』 でのみ有効） l phpfpm_start_since l FPMが起動してから経過した秒数 l phpfpm_listen_queue l 待機接続キュー内のリクエスト数 l phpfpm_max_listen_queue l FPMの起動以降、保留中の接続キューに蓄積されたリクエストの最⼤数 l phpfpm_listen_queue_length l 待機接続のソケットキューのサイズ l phpfpm_slow_requests l 『request_slowlog_timeout』 値を超えたリクエストの数 l phpfpm_accepted_connections l プールが受け付けたリクエストの数 l phpfpm_memory_peak l FPMが開始されてからのメモリ使⽤量のピーク値 プロセスの状態を⽰すメトリクス リクエストの状態を⽰すメトリクス メモリの状態を⽰すメトリクス
28. 【 アジェンダ 】 l PHP-FPMのメトリクスの取得⽅法 l 遭遇した落とし⽳ l 外部ツールとの⽐較 l メトリクスを取ってみた感想 l 最後に
29. 【 メトリクスの取得はできたが… 】 公式ページに書いてる情報と⽐べて, l 取得できないメトリクスがあったり, l Web システムを構築する環境次第で, 取得できるメトリクスに違いがあったり, した…︕ 画像の引⽤元: https://www.php.net/manual/ja/fpm.status.php
30. もう少し詳しくをお話しすると, 落とし⽳が3つ存在していた 😢
31. もう少し詳しくをお話しすると, 落とし⽳が3つ存在していた 😢 👉 それぞれの落とし⽳を軽く紹介していきます
32. 情報ページではクエリパラーメータfullをつけると プロセス単位の情報を出⼒することができるが, OpenMetrics形式の場合はこれら情報は出⼒できない 画像の引⽤元: https://www.php.net/manual/ja/fpm.status.php 【 落とし⽳ その1 】
33. 【 落とし⽳ その2 】 画像の引⽤元: https://www.php.net/manual/ja/fpm.status.php PHP-FPM Linux系OS Unix Domain Socket Linux系OS上でUNIX Domain Socketを使う場合, listen queueに関するメトリクスは 常に0の値を取る
34. メモリに関するメトリクスは, PHP 8.4.0以降からしか取れない 【 落とし⽳ その3 】 画像の引⽤元: https://www.php.net/manual/ja/fpm.status.php PHP8.1.0 PHP8.4.0 取れない
35. と, まぁ, ⾊々な落とし⽳があった訳ですが…
36. 【 つまり, ここまでで⾔いたかったこと 】 環境構築は簡単ですが, 構築した環境次第で取得できないメトリクスがあったりしたので, 実際に取得する際は注意してください︕ 詳細は記事に 書いてあります︕
37. 【 アジェンダ 】 l PHP-FPMのメトリクスの取得⽅法 l 遭遇した落とし⽳ l 外部ツールとの⽐較 l メトリクスを取ってみた感想 l 最後に
38. 前者の⽅法で取得できるメトリクスは 把握してもらえたと思うので… l PHP-FPMからOpenMetrics形式で メトリクスを取得する⽅法 l データ形式を変換する外部ツールを⽤いる⽅法
39. l PHP-FPMからOpenMetrics形式で メトリクスを取得する⽅法 l データ形式を変換する外部ツールを⽤いる⽅法 次は, 外部ツール（php-fpm_exporter）を使った 場合に取得できるメトリクスも⾒ていきます︕
40. l phpfpm_process_state l プロセスの状態 (Idle, Running, ...) l phpfpm_process_request_duration l リクエストの継続時間（マイクロ秒単位） l phpfpm_process_last_request_memory l 最後のリクエストが消費したメモリの最⼤量 l phpfpm_process_last_request_cpu l 最後のリクエストが消費したCPU使⽤率 l phpfpm_scrape_failures l PHP-FPMからのスクレイピング失敗件数 php-fpm_exporterでは前者の⽅法と⽐べて, 取得できるメトリクスは増えた︕ プロセス単位のメトリクス メトリクスのscrapeに関するメトリクス
41. ⼀⽅で, 落とし⽳で紹介したメトリクスが取得できない問題の⼀部は こちらでも似たような問題が発⽣していた 👉 同様の問題が起きる 👉 どのバージョンであっても 取れなかった
42. 【 つまり, ここまでで⾔いたかったこと 】 l 前者の⽅法と⽐べて, php-fpm_exporterを使った⽅が取得できるメトリクスは多い︕ l ⼀⽅で, こちらの⽅法を使っても, 構築する環境次第で取得できるメトリクスに違いはあるので, 注意が必要︕ 詳細は記事に 書いてあります︕
43. 【 アジェンダ 】 l PHP-FPMのメトリクスの取得⽅法 l 遭遇した落とし⽳ l 外部ツールとの⽐較 l メトリクスを取ってみた感想 l 最後に: 宣伝
44. 【 メトリクスを取ってみた感想 】 OpenMetrics形式で取得する場合は, データ形式を変換する外部ツールを使う必要がないので, ⼿軽に試せるのが良い 特にサイボウズでは, OSSセキュリティポリシー的に外部ツールの導⼊はやや障壁が⾼かったので 👉
45. 【 メトリクスを取ってみた感想 】 外部ツールを使う場合に⽐べてメトリクスが少なかったり, そもそも取れないメトリクスがあったりするのは少し残念 ログベースの調査でひとまず⾜りてるや既に取得できている別のメトリクスで補 完できる等であれば, 初めて導⼊してみる選択肢としては良さそう 👉
46. 【 アジェンダ 】 l PHP-FPMのメトリクスの取得⽅法 l 遭遇した落とし⽳ l 外部ツールとの⽐較 l メトリクスを取ってみた感想 l 最後に
47. 【 最後に 】 今回話した内容は以下の記事に詳しくまとめているので, 実際に導⼊する際には, ぜひ記事を読んでみてください︕︕ 画像の引⽤元: https://blog.cybozu.io/entry/2025/09/29/170000
48. 聞いていただき, ありがとうございました︕