I frequently use the NetBeans debugger to step through my PHP applications. However, I also want to use the debugger when working on things that do not run in a web browser, per se (specifically a REST API).
Does anybody know how to start a NetBeans debugger session that will allow me to use my REST client as the "browser"?
Misc. info: Mac OS X, CocoaRestClient, NetBeans 7.1.2.
You need several things:
activate remote debugging in your server config (xdebug.remote_enable = 1 in php.ini then restart server)
generate a Xdebug IDE key from netbeans (I don't know how to do this with netbeans, but it won't be hard to find)
ensure that Neatbeans is listening the the DBGP port (usually 9000)
add a request parameter in each request sent with your client with:
name : XDEBUG_SESSION_START
value : [your IDE key]
For me, works like a charm with PHPStorm.
To help with PHPStorm's recent REST Client - here's a screenshot of the appropriate settings. Make sure to, in settings, change the DBGP listening port from 9001 to 9000 if not set already. Thanks for the answer!
http://screencast.com/t/WsZzApBORssx
Related
I'm attempting to setup Xdebug on some containers we have at the office. We have a Ubuntu server running Docker with the firewall wide open over LAN.
Ideally each developer would like to use PhpStorm (which we work over a mounted samba drive), to debug code on various websites.
We use Apache and have the jwilder nginx proxy to server multiple sites in docker.
I've attempted to setup a DBGp proxy with no luck so far. php.ini looks like this:
xdebug.remote_enable=1
xdebug.remote_host=containername
xdebug.remote_port=9001
xdebug.remote_handler=dbgp
xdebug.remote_mode=req
Inside the container for the DBGp proxy I have it on the same network as Apache and bind the 9001 externally e.g. - "9012:9001"
Using the IDE It does appear to detect the DBGp proxy correctly in PhpStorm. I listen for connections and place the IDE key in the get variable to start Xdebug session. I've tried with the Zend Debugger extension as well. At this point no break points are hit and the script just continues.
Do I need to do anything in PhpStorm to tell PhpStorm that the file directory doesn't match the directory on the server? Am I missing something in the php.ini file.
In this scenario could I simply use remote connect back for multiple developers and get rid of DBGg? Would it pose a security risk if the port was blocked via UFW on the docker host to the external world (I presume at the very least everyone could trigger Xdebug as these development sites are exposed to the world per say)?
hard to tell what's wrong and how to solve it at this point. did you try to break at the first line of code (run->break at first line)? if this does not stop your debug connection is not established. also try xdebug.remote_connect_back instead of defining the remote host
I have a similar problem to Setting up IntelliJ Idea remote debugging with XDebug, but since no solution was posted there I'll ask it anyways.
I have a Raspberry Pi with Apache 2, PHP, xdebug set up and running on a local network.
I have a desktop with IntelliJ IDEA and the PHP plugin running in the same local network. I already successfully made an SSH connection to the remote server from IntelliJ, so when I hit "Run" it automatically uploads local files to the Raspberry Pi and opens a browser showing the php website. Now I want to be able to debug as well. I followed this page mostly: https://www.jetbrains.com/help/idea/2016.3/configuring-xdebug.html, but it is not working.
When I hit debug the browser opens with ?XDEBUG_SESSION_START=15930 appended to the URL and I see my php website. In IntelliJ the Debugger window opens with the message "Waiting for incoming connection with ide key '15930'". This number changes every time I hit debug, so I have not set xdebug.idekey in php.ini.
This is the contents of my php.ini:
[XDebug]
zend_extension = /usr/lib/php5/20131226/xdebug.so
xdebug.remote_enable=1
xdebug.remote_port=9000
xdebug.remote_mode=req
xdebug.remote_host=192.168.2.108
xdebug.show_exception_trace=On
xdebug.remote_handler=dbgp
xdebug.remote_conneck_back=1
Any ideas what might be wrong? Something with firewall settings to allow incoming connections on port 9000?
For those struggling with the same problem, the answer probably can be found by checking if your server and client make appropriate connections on the specified debug port 9000. Since in my situation there are multiple routers between the client and server and my port forwarding options in those routers are limited I kind of gave up on this approach.
Instead I installed xampp on my client and went for local debugging instead of remote debugging.
I'm setting up xdebug for php within sublime text, and xdebug keeps on logging errors related to being unable to connect:
Log opened at 2016-08-18 21:06:01
I: Connecting to configured address/port: localhost:9988.
E: Could not connect to client. :-(
Log closed at 2016-08-18 21:06:01
I hoped that debugging directly by going to http://localhost:9988 in my browser might help, but it simply displays the google chrome error page: "localhost refused to connect". Perhaps the error exists on the other end, that data can't be pushed to the sublime text client, I don't know. Sublime text xdebug does show the message "Reloading /var/log/xdebug/xdebug.log" when I run tests/etc, so it seems to be aware of the php code being run, just doesn't get any further.
So, I never thought I would have to debug xdebug itself, but: How can I debug the xdebug to code editor connection? If this were nginx, I would start debugging the virtualhost, but since it's xdebug... ...I have no idea where to start debugging the lack of an app to connect to?
## Various Configuration Settings ##
I am on ubuntu linux 14.04.
Here is my xdebug.ini conf if pertinent:
[xdebug]
xdebug.default_enable=1
xdebug.remote_enable=1
xdebug.remote_autostart=1
xdebug.remote_host="localhost"
xdebug.remote_handler="dbgp"
xdebug.remote_port=9988
xdebug.remote_mode = req
xdebug.overload_var_dump=0
xdebug.idekey = sublime.xdebug
xdebug.remote_log="/var/log/xdebug/xdebug.log"
;https://github.com/martomo/SublimeTextXdebug
Xdebug installed:
apt-cache policy php-xdebug
php-xdebug:
Installed: 2.4.0-5+donate.sury.org~trusty+1
Candidate: 2.4.0-5+donate.sury.org~trusty+1
Version table:
*** 2.4.0-5+donate.sury.org~trusty+1 0
500 http://ppa.launchpad.net/ondrej/php/ubuntu/ trusty/main amd64 Packages
100 /var/lib/dpkg/status
Module active:
php -m | grep -i xdebug
xdebug
Xdebug
phpinfo xdebug settings:
PHP debugging requires two components that collaborate: a PHP extension that acts as server and a software that knows how to talk to this extension and drive its functionality (it is the client).
However, despite the usual client-server protocols where the client connects to the server, the PHP debugger works the other way around: the server is the one that connects to the client (that should be started and listening on port 9000).
xdebug is the most known PHP extension for debug. There are many programs and program extensions/plugins that acts as clients for it. I didn't work with Xdebug package for Sublime (I didn't work with Sublime, in the first place) but the principles are the same.
How a debugging session works?
The client software (Sublime with the Xdebug package in your case) starts listening on port 9000 of localhost, waiting for the server to start the connection. It probably doesn't listen on the port all the time but only when the developer tells it so.
You start the PHP script to debug. xdebug doesn't kick in on all requests to the server but only when it finds a marker in the request. Depending on the SAPI used to run the script, the marker is either an environment variable (for CLI scripts) or a cookie or a GET or POST argument (for web pages). Read more on the "Starting The Debugger" section of the documentation.
When the PHP interpreter starts the execution of the PHP script, if xdebug finds the marker explained above then it tries to connect the xdebug client. Otherwise, it stays out of the way and lets the script run at its full speed.
When the debugging marker is present in the environment, the xdebug extension (the server) tries to connect to the xdebug client (by default on port 9000 of localhost but these settings can be changed as needed). If it cannot connect (because the client is not listening) then it logs the failure then puts itself out of the way and lets the script run at its full speed.
After it successfully connects to the client, the xdebug PHP extension either stops before running the first statement of the PHP script or runs the script until its execution reaches a breakpoint. This behaviour and the list of breakpoints are sent by the client to the server during their initial communication as the connection was established. Then the extension waits for commands from the client. The client displays to the developer the current state of the running script (the next statement to run, the values of the variables in the current scope etc) and waits for commands (run next statement, continue, add/remove breakpoints, watch some variable etc).
Why it doesn't work for you?
It's not very clear for me from your question but I'll assume you run the webserver (with the PHP interpreter and the xdebug extension) on the same computer you run the xdebug client (localhost). If this is not the case, don't despair. The solution is a command line away (read at the end of the answer).
From the information you posted in the question is clear that xdebug is installed, enabled and it works properly. The output of telnet localhost 9988 says nobody is listening on port 9988. The xdebug client should listen there.
I never worked with Sublime Text (and its packages). This article explains how to install and make it work. However, it doesn't explain how to configure it to listen on port 9988.
I would start by setting the PHP xdebug extension to connect to the default port (9000):
xdebug.remote_port=9000
and then, if everything works, I would try to find out how to configure the Sublime Text xdebug package to listen on a different port. Do you really need it to listen on a different port?
What if the web server and the xdebug client are on different computers?
If you need to debug a PHP script that runs on a remote machine the xdebug client listens on the local machine (on port 9000) and the xdebug extension tries to connect to port 9000 on the remote machine. A solution that is possible in intranets and VPNs is to configure xdebug to connect to port 9000 of the local machine but, apart from these conditions, it usually also requires changes in the firewall and/or other security software.
The easiest way to debug the PHP scripts in this situation if you have ssh access to the remote machine is to create a ssh tunnel from port 9000 of the remote machine to port 9000 of the local machine.
Assuming you use ssh to connect to the remote machine (to put the files on it), all you have to do is to append -R 9000:localhost:9000 to the command line you use to connect and start a ssh session to the remote machine.
As long as this connection is open, any connection request on port 9000 (the first 9000 on the command line above) of the remote machine (-R) is forwarded through the tunnel to the port 9000 (the second 9000 from the command line) of the local machine (localhost). This way the remote xdebug PHP extension is able to contact the remote xdebug client (assuming it is listening).
If you are using xdebug-v3, please try:
xdebug.mode=debug
xdebug.start_with_request=yes
xdebug.discover_client_host=1
This should solve your issue.
Ok, so after extensive testings of different settings, here are my suggestions for debugging the problem for people who come after me:
Do not rely on testing with only 1 xdebug client! It's trivial to install two editors/IDEs, so get an alternate editor running to make it possible to see whether there is a problem with xdebug, or with the specific client!
There can be 3 locations that carry configuration for the xdebug+xdebug client combination! The client(or editor plugin) configuration, the 20-xdebug-conf.ini file (or in php.ini equivalent), and your project-specific configuration. Make sure all 3 locations are in sync in terms of port, path_mapping, etc.
I've setup Xdebug on a local Vagrant instance running Ubuntu. It works as expected and I can setup breakpoints in my application.
I have a scenario where the application makes a request to an internal API. The internal API is on the same server and same codebase.
Tree illustration
codebase/
app/
root
api/
root
The application is accessible as https://local.myapplication.com and the API is accessible locally as http://local.api.myapplication.com).
If I now set a breakpoint in some code for the API and then visit https://local.myapplication.com/some/action/that/triggers/the/api/code the breakpoint is only triggered if I do not initialise the Xdebug session for the first application, i.e., I do not set the XDEBUG_SESSION_START query parameter. If it's set, my breakpoint is ignored.
There is a certain drawback to this. If I have a breakpoint in the application and the API, I can't trigger both at the moment. Either I can trigger the application breakpoints or the API breakpoints.
I'm using Sublime Text 3 with the plugin https://github.com/martomo/SublimeTextXdebug. My Xdebug settings in php.ini are:
zend_extension="/usr/lib/php5/20090626/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=192.168.3.1
xdebug.remote_port=9000
xdebug.remote_log="/tmp/php5-xdebug.log"
Is this fixable? Any answers/comments are appreciated!
Two choices. If the first (easier) doesn't work the second surely will.
1 - Start a new Xdebug session for each http request.
In php.ini, add the following to your xdebug settings:
xdebug.remote_autostart = 1
See documentation here
2 - Run two Xdebug sessions simultaneously.
You'll need to have two separate instances of your IDE/text editor listening to xdebug - each on a different port. You can set both instances to edit the same project while their xdebug service listens on different ports.
For example:
Your "application" -> port 9000
Your "internal API" -> port 9001
To make your "internal API" run xdebug on port 9001, you can simply do the following at the start of your "internal API" script:
ini_set('xdebug.remote_port', '9001');
Use conditional breakpoints. You can make them depend on any PHP code. E.g. set a constant for each entry point and check it. Or check the request URL.
How do you setup a multi-developer XDebug PHP environment?
I have the following setup:
I have a linux machine with Apache and Xdebug loaded and a php.ini file that I think is correct.
I found a python proxy script that I'm using to proxy the calls from the PDT Eclipse IDE's my developers are using to the Apache/Xdebug running on the same web server.
I set the idekey in php.ini to "ECLIPSE_DBGP" and for Xdebug to autostart
From the log information from the proxy it says that there is no server with the key "ECLIPSE_DBGP" and it stops the request.
Has anybody run into this or has a step by step setup to get this to work?
I have exhausted what I have found using google.
You can use ssh to tunnel the debug-connection back to your client machine. Eg. from your client machine, connect to the server with something like:
ssh -R 9000:localhost:9000 you#example.com
Then fire up your (local) debugger, and start the remote script. Xdebug (at the server) will now establish a connection to its localhost:9000, but since this port is forwarded back to your local machine, your (local) debugger will receive the connection.
If you use Windows on your client side, you can do the same thing with PuTTY.
See the documentation for Spectator for some more details.