Xdebug の設定

ローカルターミナルで、.magento.app.yaml ファイルをテキストエディターで開きます。

runtime セクションの extensions で、xdebug を追加します。 例：

runtime:
    extensions:
        - redis
        - xsl
        - newrelic
        - sodium
        - xdebug

変更内容を .magento.app.yaml ファイルに保存し、テキストエディターを終了します。

変更を追加、コミットおよびプッシュして、環境を再デプロイします。

git add .magento.app.yaml

git commit -m "add xdebug"

git push origin <environment-ID>

PhpStorm プロジェクトで、設定 パネルを開きます。

• macOS - PhpStorm/設定 を選択します。
• Windows/Linux - ファイル/設定 を選択します。

設定 パネルで「PHP」セクションを展開し、「サーバー」をクリックします。

+ をクリックして、サーバー設定を追加します。 プロジェクト名は、上部がグレーで表示されます。

[ オプション ] 新しいサーバー設定に対して次の設定を行います。 PHPStorm ドキュメントの デバッグサーバーが設定されていませんを参照してください。

• 名前 - ホスト名と同じ名前を入力します。 デバッグに CLI を使用するには、この値が Debug CLI コマンドの PHP_IDE_CONFIG 変数の値と一致する必要があります。
• ホスト - ホスト名を入力します。
• ポート - 443 と入力します。
• デバッガー - 「Xdebug」を選択します。

パスマッピングを使用 を選択します。 ファイル/ディレクトリ ペインに、serverName のプロジェクトのルートが表示されます。

サーバー上の絶対パス 列で 編集 アイコンをクリックし、環境に基づいて設定を追加します。

• すべてのスターター環境および Pro 統合環境では、リモートパスは /app です。

• ステージング環境および実稼動環境の場合：

  • 実稼動：/app/<project_code>/
  • ステージング：/app/<project_code>_stg/

Xdebug ポートを 9000,9003 に変更するか、PHP/Debug/Xdebug/Debug Port パネルでポートを 9000 のみに制限できます。

適用 をクリックします。

PHPStorm アプリケーションを開き、画面の右上にある Add Configuration をクリックします。

「Add new run configuration」をクリックします。

PHP Remote Debug オプションを選択します。

• 識別できる一意の名前を入力してください。
• 「Filter debug connection by IDE key**」チェックボックスをオンにします。
• 前の節で作成したサーバーを選択します。 まだ作成していない場合は、ここで作成できますが、設定ガイドのその部分を参照してください。
• 「IDE key(session id)」テキストフィールドに、大文字で PHPSTORM と入力します。 これは設定の他の部分で使用するので、同じにしておくことが重要です。 別の文字列を選択する場合は、設定および設定プロセスの他の場所でも使用する必要があります。

Apply/OK をクリックします。

ターミナルを開きます。

SSH を使用して接続を確立します。

ssh -R 9000:localhost:9000 <ssh url>

-v （verbose） オプションを使用すると、転送中のポートにソケットが接続されるたびに、端末に表示されるようになります。

「接続できません」または「リモートのポートをリッスンできませんでした」というエラーが表示される場合は、ポート 9000 を占有しているサーバー上に、別のアクティブな SSH セッションが存在している可能性があります。 その接続が使用されていない場合は、終了できます。

SSH を使用して、リモート統合、ステージング、または実稼動環境にログインします。

SSH セッションのリストを表示します：who

ユーザー別の既存の SSH セッションを表示します。 自分以外のユーザーに影響を与えないように注意してください。

• 統合：ユーザー名は dd2q5ct7mhgus に似ています
• ステージング：ユーザー名は dd2q5ct7mhgus_stg に似ています
• 実稼働：ユーザー名は dd2q5ct7mhgus に似ています

ユーザーセッションが古い場合、pts/0 などの擬似端末（PTS）値を見つけます。

PTS 値に対応するプロセス ID （PID）を強制終了します。

ps aux | grep ssh
kill <PID>

応答の例：

dd2q5ct7mhgus        5504  0.0  0.0  82612  3664 ?      S    18:45   0:00 sshd: dd2q5ct7mhgus@pts/0

接続を終了するには、プロセス ID （PID）を指定して kill コマンドを入力します。

kill 3664

まだ行っていない場合は、Putty をダウンロードしてください。

パテを起動します。

カテゴリ ウィンドウで、[セッション] をクリックします。

次の情報を入力します。

• ホスト名（または IP アドレス） フィールド：クラウドサーバーの SSH URL を入力します
• ポート フィールド：22 を入力します

カテゴリ パネルで、接続/SSH/トンネル をクリックします。

次の情報を入力します。

• Source ポート フィールド：9000 を入力
• 宛先 フィールド：127.0.0.1:9000 を入力します
• リモート をクリックします

追加 をクリックします。

カテゴリ ウィンドウで、「セッション」をクリックします。

「Saved Sessions」フィールドに、この SSH トンネルの名前を入力します。

保存 をクリックします。

SSH トンネルをテストするには、Load をクリックし、Open をクリックします。

「接続できません」というエラーが表示される場合は、次の点を確認してください。

• Putty の設定はすべて正しい
• クラウドインフラストラクチャ上のプライベートAdobe Commerceの SSH キーがあるマシンで Putty を実行しています

ターミナルを開きます。

クラスターの各 web ノードに対するすべての SSH セッションをクリーンアップします。

ssh USERNAME@CLUSTER.ent.magento.cloud 'rm /run/platform/USERNAME/xdebug.sock'

クラスターの各 web ノードに対して、Xdebug 用の SSH トンネルを設定します。

ssh -R /run/platform/USERNAME/xdebug.sock:localhost:9000 -N USERNAME@CLUSTER.ent.magento.cloud

リモートデバッグを有効にします。ブラウザーでサイトにアクセスし、URL に次の KEY を追加します（xdebug_key の値）。

?XDEBUG_SESSION_START=KEY

この手順では、ブラウザーリクエストをトリガーXdebug に送信する Cookie を設定します。

Xdebug を使用してデバッグを完了します。

セッションを終了する準備が整ったら、次のコマンドを使用して cookie を削除し、ブラウザーでのデバッグを終了します。KEY は xdebug_key の値です。

?XDEBUG_SESSION_STOP=KEY

CLI コマンドを使用して、デバッグ対象のサーバに SSH で接続します。

次の環境変数を作成します。

export XDEBUG_CONFIG='PHPSTORM'

export PHP_IDE_CONFIG="serverName=<name of the server that is configured in PHPSTORM>"

これらの変数は、SSH セッションが終了すると削除されます。

デバッグの開始

スターター環境と Pro 統合環境では、CLI コマンドを実行してデバッグします。
次のような実行時オプションを追加できます。

php -d xdebug.profiler_enable=On -d xdebug.max_nesting_level=9999 bin/magento cache:clean

ステージング環境および実稼動環境では、CLI コマンドのデバッグ時に Xdebug PHP 設定ファイルへのパスを指定する必要があります。次に例を示します。

php -c /etc/platform/USERNAME/php.xdebug.ini bin/magento cache:clean

拡張機能 メニューで デバッグ をクリックして有効にします。

右クリックしてオプションメニューを選択し、IDE キーを PHPSTORM に設定します。

ブラウザーに Xdebug クライアントをインストールします。 を設定して有効にします。

クラウドサーバーへの SSH トンネルを作成します。

Chrome ストアから Xdebug Helper 拡張機能をインストールします。

次の図に示すように、Chromeで拡張機能を有効にします。

Chromeで、Chrome ツールバーの緑のヘルパーアイコンを右クリックします。

ポップアップメニューで、「オプション」をクリックします。

IDE キー リストから、「PhpStorm」をクリックします。

保存 をクリックします。

PhpStorm プロジェクトを開きます。

上部のナビゲーションバーで、「リスニングを開始 アイコンをクリックします。

ナビゲーションバーが表示されない場合は、表示 > ナビゲーションバー をクリックします。

PhpStorm のナビゲーションペインで、テストする PHP ファイルをダブルクリックします。

SSH を使用してリモート環境にログインします。

ファイルを圧縮します。

tar -czf /tmp/<file-name>.tgz <directory list>

例えば、vendor ディレクトリのみを圧縮するには、次のようにします。

tar -czf /tmp/vendor.tgz vendor

ローカル環境では、PhpStorm を使用してファイルを圧縮します。

cd <phpstorm project root dir>

rsync <SSH-URL>:/tmp/<file-name>.tgz .

tar xzf <file-name>.tgz