オープンソースの販売サイト構築ソフト EC-CUBE についてのメモ。

Xdebug

インストール

Yum

# yum list \*xdebug\*
# yum install php-pecl-xdebug.i386

PECL

# dnf install php php-devel php-pear
# pecl install xdebug
PHP 7.2-7.4 の場合
# pecl install xdebug-3.1.6
# vi /etc/php.d/user.ini
+zend_extension=/usr/lib64/php/modules/xdebug.so

プロファイリング

下準備

# mkdir /php-xdebug
# chown apache /php-xdebug

/html/.htaccess

Linux

php_flag xdebug.profiler_enable 1
php_value xdebug.profiler_output_dir "/php-xdebug"
php_flag xdebug.profiler_append 0
php_value xdebug.profiler_output_name "cachegrind.out.%u_%R"

Windows

php_flag xdebug.profiler_enable 1
php_value xdebug.profiler_output_dir "C:\app\php-52-ts\xdebug"
php_flag xdebug.profiler_append 0
php_value xdebug.profiler_output_name "cachegrind.out.%u_%R"

リモートデバッグ

VSCode

クライアント側

  • SSH 接続で、PHP Debug by Xdebug の「Listen for Xdebug」を利用した。
    • プラグインが Listen するポート (デフォルト 9003) は、サーバー上となる。よって、SSH トンネルを手動設定する必要は無い。
    • configurations.hostname: “127.0.0.1” で、IPv4 リッスン可能。しかし、デフォルトの localhost 設定で、IPv6, IPv4 双方にアクセスを試みる様子だった。よって、通常この設定は不要そう。
    • PHP by DEVSENSE のみでもデバッグできた。

サーバー側

  • ページにアクセスすると、Xdebug から、プラグインが Listen するポート (デフォルト 9003) へアクセスする。
  • 未検証だが、PHP コードから発火させる方法もありそう。その方が、IP 分岐など、運用への影響を抑えられそうな気もする。

PHP 5.4 (Xdebug 2.2.7) (FCGI)

実際に動作した設定。

  • PHP 5.3.3 (Xdebug 2.1.4) (FPM) でも同様で動作した。
.user.ini
xdebug.remote_enable = on
xdebug.remote_autostart = on
xdebug.remote_port = 9003
  • FCGI のタイムアウトの延長に FcgidIOTimeout が有用だと思うが、Context: server config, virtual host なので、.htaccess では設定できないと考えられる。(他の回避方法があるか不明。)

PHP 5.6 (Xdebug 2.5.5)

実際に動作した設定。

.htaccess
php_flag xdebug.remote_enable on
php_flag xdebug.remote_autostart on
xdebug.remote_port = 9003 

PHP 7.4 (Xdebug 2.9.5)

「PHP 5.4 (Xdebug 2.2.7) (FCGI)」同様の設定で動作した。(/etc/php.d/*.ini に記述した。)

PHP 7.4 (Xdebug 3)

実際に動作した設定。

  • PHP 7.2 (Xdebug 3.1.6) でも同様で動作した。
/etc/opt/remi/php74/php.d/user.ini
# xdebug.client_host = "localhost"
# xdebug.client_port=9003
xdebug.mode=develop,debug
  • ドキュメントベースで確認し、xdebug.client_hostxdebug.client_port は、デフォルト値なので不要そう。
  • 公開サーバーで無差別に受け付けるのは危険を感じる。HTTP リクエスト側のIP制限などの対策が必要だと思う。
.user.ini
xdebug.start_with_request=yes
.htaccess
php_value xdebug.start_with_request yes

設定の記述先について

xdebug.mode

  • 公式ドキュメントによると、 .htaccess 不可。Apache VHOST 不可。PHP-FPM プール不可(?)。
  • .htaccess も .user.ini も不可。(実際に試した。)
  • カンマ区切りで複数指定可能。

xdebug.start_with_request

  • .htaccess も .user.ini も可能だった。(実際に試した。) 無論、php.ini も可能。

別の発火方法

xdebug.remote_autostart や xdebug.start_with_request を使わずデバッグする方法。その方が、多分安全。

WEB

  • 問い合わせ文字列 XDEBUG_SESSION_START=<値> をセットする。(デフォルトでは値は何でも良い。空文字も可。)
    • XDEBUG_SESSION_STOP で停止。
    • セッション期間中は、クッキー XDEBUG_REMOTE_SESSION がセットされる。(毎回問い合わせ文字列をセットする必要はない。)
  • クッキー XDEBUG_REMOTE_SESSION をセットする。

コマンドライン

  • 環境変数 XDEBUG_CONFIG をセットする。

# XDEBUG_CONFIG=1 ./foo.php
# sudo -u apache XDEBUG_CONFIG=1 ./foo.php

資料

tips/xdebug.txt · 最終更新: 2024/03/01 23:09 by seasoft
© 2008-2024 Seasoft.