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 > Settings​を選択します。
• Windows/Linux - ファイル > 設定​を選択します。

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

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

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

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

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

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

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

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

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

Xdebug ポートを9000,9003に変更するか、PHP > デバッグ > Xdebug > デバッグポート パネルで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 （詳細）オプションを使用します。

「接続できません」または「リモートでポートをリッスンできませんでした」というエラーが表示された場合は、ポート 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をダウンロードしてください。

Puttyを開始します。

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

次の情報を入力します。

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

カテゴリ ペインで、接続 > SSH > トンネル​をクリックします。

次の情報を入力します。

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

「追加」をクリックします。

カテゴリー ペインで、セッション​をクリックします。

「保存済みセッション」フィールドに、この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

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

?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

Pro ステージング環境および実稼動環境では、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