Xdebug

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

# 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

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 の場合、xdebug.profiler_output_dir を以下要領で変える。

php_value xdebug.profiler_output_dir "C:\app\php-52-ts\xdebug"

• 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.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 では設定できないと考えられる。(他の回避方法があるか不明。)

実際に動作した設定。

.htaccess

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

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

実際に動作した設定。

• 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_host と xdebug.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 も可能。

通常との差異。

php.ini

xdebug.client_host = host.docker.internal

.vscode/launch.json

{
    "configurations": [
        {
            "pathMappings": {
                "/var/www/app": "${workspaceRoot}",
            },
        },
    ],
}

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

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

• 環境変数 XDEBUG_SESSION をセットする。
  • v2 では、XDEBUG_CONFIG を使う。

例

$ XDEBUG_SESSION=1 ./foo.php
# sudo -u apache XDEBUG_SESSION=1 ./foo.php
$ docker compose exec -T -e XDEBUG_SESSION=1 <サービス名> php

• http://www.xdebug.org/docs/all_settings

.user.ini
; for xdebug 2
xdebug.remote_enable = ${PHPFPM_xdebug_remote_enable}
xdebug.remote_autostart = ${PHPFPM_xdebug_remote_autostart}
; for xdebug 3
xdebug.start_with_request = ${PHPFPM_xdebug_start_with_request}

.htaccess
# 開発サイト
# - 別名によるブレを回避するため HTTP_HOST を使わず、SERVER_NAME を使っている。(効果未検証)
<If "%{SERVER_NAME} =~ /^dev\./">
    SetEnv PHPFPM_xdebug_remote_enable on
    SetEnv PHPFPM_xdebug_remote_autostart on
    SetEnv PHPFPM_xdebug_start_with_request yes
</If>
# 本番サイト
<Else>
    SetEnv PHPFPM_xdebug_remote_enable off
    SetEnv PHPFPM_xdebug_remote_autostart off
    SetEnv PHPFPM_xdebug_start_with_request no
</Else>