62

I would like to try Xdebug 3.0.0RC1 to explore what has changed and the new features that come with it. I am also using the latest PhpStorm 2020.3 EAP which supports Xdebug 3 with no major config needed. Below is my PhpStorm config for the Debugger:

enter image description here

And here is the configuration I have tried for Xdebug3:

zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20170718/xdebug.so
xdebug.mode=debug
xdebug.start_with_request=yes
xdebug.client_host=host.docker.internal # here I tried several combinations like: "localhost", "127.0.0.1", "172.17.0.1"
xdebug.client_port=9001 # here I tried several ports 9003 included with no success

I have also tried not adding the client_host/client_port setting at all and still failing.

I am getting this error:

Script php bin/console doctrine:cache:clear-metadata returned with error code 255
!!  [17-Nov-2020 15:24:40 UTC] Xdebug: [Step Debug] Could not connect to debugging client. Tried: host.docker.internal:9001 (through xdebug.client_host/xdebug.client_port) :-(
!!  [17-Nov-2020 15:24:41 UTC] PHP Fatal error:  Method class@anonymous::__toString() must not throw an exception, caught Symfony\Component\DependencyInjection\Exception\AutowiringFailedException:  in /var/www/vendor/symfony/symfony/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php on line 233

Some info about my environment:

  • Fedora 33
  • Docker version 19.03.13, build 4484c46d9d
  • PhpStorm 2020.3 EAP Build #PS-203.5784.36

It is curious (because apparently host.docker.internal is "not" supported by the Docker version I am using and yet it works) and weird at the same time that the following configuration does work with Xdebug 2 even having the debugger listening for incoming connections all the time:

enter image description here

zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20170718/xdebug.so
xdebug.remote_autostart=0
xdebug.remote_enable=1
xdebug.remote_host=host.docker.internal
xdebug.remote_port=9000

What I am missing here?

Note: I already applied the solution provided by the Xdebug developer here.

Improve this question
23
  • 1
    What is your OS? Commented Nov 17, 2020 at 15:46
  • 2
    host.docker.internal is NOT supported on Linux -- only Windows and Mac -- github.com/docker/for-linux/issues/264 . It will be supported since Docker v20 -- github.com/docker/for-linux/issues/264#issuecomment-714253414 . If you want to use that host name, your would need to detect the IP address dynamically (the aforementioned link has many options on how to achieve that). Commented Nov 17, 2020 at 15:54
  • 1
    @ReynierPM You may have that other option in place (e.g. xdebug.remote_connect_back = 1 -- Xdebug 2 equivalent of Xdebug's 3 xdebug.discover_client_host = true). Use explicit IP address (hardcode it) .. or detect it dynamically. Commented Nov 17, 2020 at 15:59
  • 1
    @LazyOne it didn't work either :( Xdebug: [Step Debug] Could not connect to debugging client. Tried: 10.211.55.12:9001 Commented Nov 17, 2020 at 16:02
  • 3
    Just spent the entire night working on this. Turns out ufw was enabled and it was blocking the port. ufw allow 9003 fixed this, but should probably lock it down by IP/device Commented Jul 27, 2021 at 20:48

18 Answers 18

Reset to default
61

PHP 7.4
Docker
PHPStorm 2020.1
Xdebug 3.1.0

Install Xdebug in your docker container using Dockerfile

RUN pecl install xdebug-3.0.1 && docker-php-ext-enable xdebug

Configure php.ini with following:

[xdebug]
xdebug.mode = debug
xdebug.start_with_request = yes
xdebug.discover_client_host = 1

Go to PHPStorm - Settings - PHP - Debug - Xdebug and set the port to 9003 (by default)

PHPStorm

That's it (:

If you want to enable/disable debugger only when you need it: just install a browser extension called "Xdebug helper", select "Debug" and remove "xdebug.start_with_request = yes" from php.ini

[xdebug]
xdebug.mode = debug
xdebug.discover_client_host = 1
Improve this answer
Sign up to request clarification or add additional context in comments.

3 Comments

I tried this exact configuration, but I still get Could not connect to debugging client. Tried: 172.19.0.1:9003 (from REMOTE_ADDR HTTP header)
Adding xdebug.discover_client_host = 1 and double checking my ports was the solution, thanks!
Why does this fix the problem?
38

What worked for me was to change start_with_request from yes to trigger.

This worked for me:

xdebug.mode=debug
xdebug.start_with_request=trigger
xdebug.client_port=9003

EDIT: As pointed out in the comments, the trigger/9003 are the default settings. If this answer works for you, it means something is overriding the default settings, and by explicitly using trigger/9003, you force back to the default settings.

Improve this answer

4 Comments

Note that xdebug.start_with_request is automatically set to trigger when xdebug.mode=debug, so it's not needed to be defined. The xdebug.client_port=9003 is also the default for Xdebug 3, so that is not needed either. Refs: xdebug.org/docs/all_settings#start_with_request xdebug.org/docs/all_settings#client_port
why does it work?
@KhayLeng It seems something is overriding the default settings, and by setting trigger/9003, you force the settings back to the defaults. I just edited my answer to add this information.
xdebug.start_with_request=trigger instead of =yes did it for me
17

I created a very simple configuration that allows me to use Xdebug with any PHP version with minimal effort (v2: 5.6-7.1, v3: 7.2-8.x). All I need to do is configure PhpStorm and docker-compose.yml in three places and I can debug.

Configuration:

gander/dev @ xdebug2.ini:

zend_extension=xdebug.so
; https://2.xdebug.org/docs/all_settings
; ------------------------------------
; Enables Step Debugging
xdebug.remote_enable=1
; ------------------------------------
; Address where IDE listening for incoming debugging connections
xdebug.remote_host=host.docker.internal
; ------------------------------------
; Port where IDE listening for incoming debugging connections
xdebug.remote_port=9003
; ------------------------------------
; Color var_dumps when in CLI
xdebug.cli_color=1
; ------------------------------------

gander/dev @ xdebug3.ini:

zend_extension=xdebug.so
; https://xdebug.org/docs/all_settings
; ------------------------------------
; Enables Step Debugging
xdebug.mode=debug,develop
; ------------------------------------
; Address where IDE listening for incoming debugging connections
xdebug.client_host=host.docker.internal
; ------------------------------------
; Port where IDE listening for incoming debugging connections
xdebug.client_port=9003
; ------------------------------------
; Color var_dumps when in CLI
xdebug.cli_color=1
; ------------------------------------

gander/dev @ docker-compose.yml:

version: '3.7'

services:
#...
  dev74:
    hostname: 'dev-74'
    container_name: 'dev_74'
    image: 'gander/dev:7.4'
    volumes:
      - './app/xdebug3:/www/localhost'
    working_dir: '/www/localhost/public'
    ports:
      - '8074:80'
    extra_hosts:
      - "host.docker.internal:host-gateway"
    environment:
      PHP_IDE_CONFIG: "serverName=dev.74"
#...

Run via CLI:

XDEBUG_SESSION=1 XDEBUG_CONFIG=1 php script.php

or:

docker-compose exec dev74 bash -c 'XDEBUG_SESSION=1 XDEBUG_CONFIG=1 php index.php'

Side notes:

This serverName:

PHP_IDE_CONFIG: "serverName=dev.74"

This is the name of the PhpStorm PHP server (shown in the screenshot below)

Screenshots:

xdebug port configuration validation

Here is a list of extensions for various browsers: Browser debugging extensions

Improve this answer

1 Comment

Files moved in repo: fixed
8

PHP 7.3
Docker (for Mac)
PhpStorm 2021.1

You may not need to install it via PECL (which took a long time to build and didn't work for me).

All I did was adding php7.3-xdebug to my apt-get install command and configure the port mapping correctly as follows:

In Dockerfile add: RUN apt-get install -y php7.3-xdebug

In docker-compose.yml I mapped an extra_host (this was the secret sauce for me):

services:
  web:
    extra_hosts:
      - "host.docker.internal:host-gateway"

In php.ini:

[xdebug]
xdebug.mode=debug
xdebug.client_host=host.docker.internal

;optionals: (uncomment if you need them)
;xdebug.start_with_request=yes
;xdebug.discover_client_host=1

In PhpStorm I just started listening to port 9003 and configured the server mapping to my needs.

References:

Improve this answer

3 Comments

I don't think the extra_hosts is needed here. That mapping may have been needed at one time (with a linux host). Why did you add it? What is your host OS?
@marcguyer I'm using MacOs.
The host.docker.internal DNS is automatically set on macOS, so no need for this line.
5

I will start saying big thanks to @LazyOne who spent some time helping me on this one until we make it to work. Here is how the config looks like for me currently and it is working fine:

zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20170718/xdebug.so
xdebug.mode=debug
xdebug.client_port=9005

You need also to update the Xdebug port at File | Settings | Languages & Frameworks | PHP | Servers to reflect the new one but also enable the option to listen on Xdebug3 incoming connections. (I believe it is enabled by default in PhpStorm 2020.3)

enter image description here

That is the setup for a backend project where no browser is in the middle, I have not tried but for those, you might need:

xdebug.start_with_request=yes

And also have File | Settings | Languages & Frameworks | PHP | Servers well configured.

Note: We found the host had enabled IPv6 and I disabled it and in addition, added the following setting to the IDE through Help > Edit Custom VM options: -Djava.net.preferIPv4Stack=true. After added the IP4 setting to the IDE I haven't tried re-enabling IPv6 and see if Xdebug 3 still working

Improve this answer

2 Comments

so what was the issue ? (apart from different port) ? I mean it looks the same as it is in question and earlier today removing host didn't work either iirc
@FaizanAkramDar I guess the problem was indeed the host. All I tried today was using it but the latest attempt was without it and it worked. I could revert the IPv6 and see if that cause any issues as well.
4

I would like to point the attention to the following configuration option in the ini file, because that is what solved the same problem for me.

xdebug.client_host=host.docker.internal

In PhpStorm's documentation here says that xdebug.remote_host=host.docker.internal has to be configured which seams similar, but is not.

A slight difference is that I use IntelliJ.

Improve this answer

1 Comment

remote_host is for Xdebug 2, and client_host is for Xdebug 3.
3

For wsl you need to force the client host.

Just open a command prompt:

wsl hostname -I

And this will give the ip:

C:\Users\rapha>wsl hostname -I 172.23.103.149

So them put at you xdebug.ini

xdebug.client_host=172.23.103.149

Improve this answer

Comments

1

I have the same issue if i'm working with the CLI:

Xdebug: [Step Debug] Could not connect to debugging client. Tried: 127.0.0.1:9003 (fallback through xdebug.client_host/xdebug.client_port) :-(

And this is my configuration that causes the warning message:

[XDebug]
...
xdebug.mode=develop,debug
xdebug.discover_client_host=1
xdebug.start_with_request = yes
xdebug.client_host = 127.0.0.1
xdebug.client_port = 9003

I'm using the config for debugging from the URL, which is using the FPM, and it's working fine.

However, if I'm working with the CLI, then I must change the config, especially the xdebug.start_with_request

before (FPM):

xdebug.start_with_request = yes

after (CLI):

xdebug.start_with_request = trigger

As an additional information, I'm using Xdebug 3.

Improve this answer

Comments

1

To fix this error "Xdebug: [Step Debug] Could not connect to debugging client. Tried: 127.0.0.1:9001 (fallback through xdebug.client_host/xdebug.client_port)." I found that I have to launch the Debugging on the Editor first, then start the web server because when you launch the Debugging on the Editor it will open the port 9001 as you set on the launch.json config then Xdebug on PHP can connect to this port.

Improve this answer

Comments

0

I had the same issue. I still have it when doing a request from a browser, but from the commandline, like in your case, it now works. What I was missing was a Server configuration with a path mapping. Once it set that up, along with the settings that you already have, it worked. I am on Mac Os Big Sur, using PhpStorm 2020.3

Improve this answer

Comments

0

To remove this error displaying in the console. Please mention the log path Xdebug going to use to store the logs. something similar mention below

xdebug.log=/var/www/var/log/xdebug.log
Improve this answer

1 Comment

I feel like this suppresses the message in the console but doesn't solve the problem
0

If you have tried all the above answers and still cannot connect to the XDebug server, try to add a new ALLOW rule for your Xdebug port (9003 by default) or turn off your local firewall (not recommended, but it works).

Ubuntu and Mint firewall interface is ufw and you can allow port 9003 by issuing the following command:

sudo ufw allow 9003

Verify the changes with:

sudo ufw status

Improve this answer

2 Comments

Running on Linux Mint, I had the same problem. After typing the allow command, I noticed it added a new rule to the firewall software GUI. And now it's working.
This would open the port publicly, to be safer better to specify the subnet range something like this... SUBNET_RANGE=$( docker network inspect your_docker_network_name | grep Subnet | awk '{ print $2 }' | egrep -o '[^",]+' ); sudo ufw allow from "$SUBNET_RANGE" to any port 9003 proto tcp;
0

Using Docker.

Solved by editing the auto generated launch.json file:

In the config "name": "Launch Built-in web server" Replace any occurrence of localhost to thecontainer's name.

In my case:

{
  "name": "Launch Built-in web server",
  "type": "php",
  "request": "launch",
  "runtimeArgs": [
    "-dxdebug.mode=debug",
    "-dxdebug.start_with_request=yes",
    "-S",
    "magento:0"
  ],
  "program": "",
  "cwd": "${workspaceRoot}",
  "port": 9003,
  "serverReadyAction": {
    "pattern": "Development Server \\(http://magento:([0-9]+)\\) started",
    "uriFormat": "http://magento:%s",
    "action": "openExternally"
  }
}

I replaced all localhost with magento (the container name).

I believe same solution should work for local development (not using Docker) if you are using custom domain name rather than localhost.

Improve this answer

Comments

0

working on ubuntu php 8.1 xdebug on ini

    zend_extension=xdebug
    [xdebug]
    xdebug.mode=develop,debug
    xdebug.client_host=host.docker.internal
    xdebug.discover_client_host=1
    xdebug.start_with_request=yes

launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for XDebug on Docker",
            "type": "php",
            "request": "launch",
            "port": 9003,
            "pathMappings": {
                "/var/www/html/": "${workspaceFolder}"
            }
        }
    ]
}
Improve this answer

Comments

0

Another solution in Windows that sorted this issue quickly for me. The docker desktop is generating some lines in your hosts file with the IP that you laptop has the first time you run the docker application. If your IP is changed (run ipconfig in cmd to get your IP) then this information might not be updated. Therefore, just go to your host file an update the IP in the below lines IPs need to be updated

Improve this answer

Comments

0

Just turn off log level with xdebug.log_level=0 in xdebug.ini file

Improve this answer

Comments

0

In my case, Xdebug couldn't connect because the debug client was listening on IPv6 (::9003). Changing it to IPv4 (0.0.0.0:9003) fixed the issue.

Improve this answer

Comments

-4

I had same problem ( ubuntu 20.4 - docker 20.10 - xdebug 3)

My solution was:

  1. xdebug.discover_client_host=1
  2. Disable firewall sudo ufw disable
Improve this answer

1 Comment

Disabling the Firewall completly can never be a solution

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.