Xdebug によるプロファイリング

Xdebug をセットアップする

1. Xdebug ツールをダウンロードしてインストールしてください。

2. Xdebug と PHP エンジンの統合。

3. PhpStorm と Xdebug を統合します。

php.ini で Xdebug プロファイラーを構成する

1. エディターでアクティブな php.ini ファイルを開きます:

   1. 設定ダイアログ (Ctrl+Alt+S) で、PHP をクリックします。

   2. 表示される PHP ページで、CLI インタープリターフィールドの横にある をクリックします。

   3. 開いている CLI インタープリターダイアログで、構成ファイル読み取り専用フィールドにアクティブな php.ini ファイルへのパスが表示されます。エディターで開くをクリックします。

2. 次のいずれかの方法で Xdebug プロファイラモードを有効にします。

   • プロファイラーを永続的に有効にするには、 xdebug.mode (英語) (Xdebug 3 の場合) または xdebug.profiler_enable (英語) (Xdebug 2 の場合) 設定を profile に設定します。

     xdebug.mode = profile

     xdebug.profiler_enable = 1

   • XDEBUG_PROFILE Cookie または GET/POST パラメーターを使用してブラウザーからプロファイラーをトリガーできるようにするには、使用する Xdebug バージョンに応じて次の設定を行います。

     xdebug.mode = profile xdebug.start_with_request = trigger

     xdebug.profiler_enable = 0 xdebug.profiler_enable_trigger = 1

3. プロファイリングスナップショットを保存する場所を指定します。

   1. xdebug.output_dir (英語) (Xdebug 3) または xdebug.profiler_output_dir (英語) (Xdebug 2) 設定を追加し、その値としてディレクトリへのパスを指定します。

      xdebug.output_dir = <path to output folder>

      xdebug.profiler_output_dir = <path to output folder>

   2. xdebug.profiler_output_name (英語) 設定を追加し、スナップショットを保存するファイルの名前をその値として指定します。

      デフォルト値は cachegrind.out.%p で、%p は名前形式指定子です。デフォルト値を使用するか、サポートされている形式指定子(英語)に従ってカスタムファイル形式を定義します。名前は常に cachegrind.out である必要があることに注意してください。

      xdebug.profiler_output_name = cachegrind.out.%p

ブラウザーからプロファイラーの切り替えを構成する

XDEBUG_PROFILE cookie または GET/POST パラメーターを指定するには、以下のいずれかを実行します。

• 手動で値を指定します(英語)。

• ブックマークレットを生成してデバッガーを切り替えます。これらのブックマークレットは、ブラウザーのツールバーに表示されます。デバッガーのクッキーを制御し、デバッガーを有効または無効にします。

  1. ブラウザーの種類に応じて、次のいずれかを実行して、ブラウザーでブックマークツールバーを有効にします。

     • Firefox では、表示 | ツールバー | ブックマークツールバーを選択します。

     • Chrome では、ブックマーク | ブックマークバーを表示を選択します。

  2. Xdebug および Zend デバッガーのブックマークレットジェネレーターページを開き、デバッグエンジンの設定を確認して、生成をクリックします。リストされたデバッグ関連アクションのブックマークが生成されます。

  3. 生成されたリンクをブラウザーのブックマークツールバーにドラッグします。

以下のいずれか 1 つを実行します:

• アプリケーション全体のデバッグを開始するには、タイプ PHP Web ページのデバッグ構成を作成し、 をクリックしてデバッグを開始します。

  詳細は、PHP Web ページのデバッグ構成でデバッグするを参照してください。

• 特定の PHP HTTP リクエストをデバッグするには、タイプ PHP HTTP リクエストのデバッグ構成を定義し、 をクリックしてデバッグを開始します。

  詳細は、PHP HTTP リクエストをデバッグするを参照してください。

• ゼロ設定のデバッグセッションを開始するには、次のようにします。

  1. PhpStorm ツールバーまたはステータスバーの PHP のデバッグ接続を聞く開始ボタン を切り替えて、 に変更します。その後、PhpStorm は現在のプロジェクトで使用されているデバッグエンジンのポートのリッスンを開始します。デバッグポートは、設定ダイアログ (Ctrl+Alt+S) の PHP | デバッグページの PhpStorm レベルで設定されます。

  2. ブラウザーでアプリケーションの開始ページを開き、デバッガーを起動するブックマークを選択してブラウザーからデバッグエンジンをアクティブにし、現在のページ（アプリケーションの開始ページ）を再ロードしてから PhpStorm に戻ります。

プロファイラーによって蓄積されたデータを取得する

1. メインメニューで、ツール | Xdebug プロファイラーのスナップショットを分析に移動します。

2. 開いた Xdebug プロファイラスナップショットを選択ダイアログで、プロファイリングデータが保存されているフォルダーとファイルを選択します。

   PhpStorm は、収集したプロファイリングデータを、別のエディタータブに、選択したプロファイラ出力ファイルの名前とともに表示します。

   

   一度に複数のスナップショットを選択して開くことができます。この場合、PhpStorm は選択したすべてのスナップショットからプロファイリングデータを集計し、平均した結果を 1 つのタブに表示します。

プロファイリングデータを調べる

タブを切り替えてプロファイリングデータを分析します。タブ内の特定の機能をすばやく見つけるには、スピード検索を使用します。

• 実行統計 : このタブを使用して、呼び出されたすべての関数の実行メトリクスに関する概要情報を調べます。

• 呼び出しツリー : このタブを使用して、呼び出されたすべての関数の実行パスを調べます。

• 呼び出し先 : このタブを使用して、呼び出しツリータブで選択した特定の関数の実行パスを調べます。

• 呼び出し元 : このタブを使用して、呼び出しツリータブで選択した特定の関数を呼び出す可能性のあるすべてのパスを調べます。