The XDebug plugin will remove the X-Debug header from the client request and inject the desired headers into the client response. XDebug is a global plugin. It is installed by adding it to the plugin.config file. It currently takes a single. Apache Traffic Server v: 7.1. Documentation - all settings. This section describes all available configuration settings available in Xdebug. Unless specifically mentioneds, each setting can be set in php.ini, files like 90-xdebug.ini, but also in Apache's.htaccess and PHP-FPM's.user.ini files. A select set of settings can be set through an XDEBUGCONFIG environment variable. In this situation, the xdebug.
The XDebug plugin allows HTTP clients to debug the operation ofthe Traffic Server cache using the default X-Debug header. The pluginis triggered by the presence of the X-Debug or the configured header inthe client request. The contents of this header should be the names of thedebug headers that are desired in the response. The XDebug pluginwill remove the X-Debug header from the client request andinject the desired headers into the client response.
XDebug is a global plugin. It is installed by adding it to theplugin.config file. It currently takes a single, optionalconfiguration option, --header. E.g.
This overrides the default X-Debug header name.
Debugging Headers¶
The XDebug plugin is able to generate the following debugging headers:
Via header is requested, the XDebug plugin sets theproxy.config.http.insert_response_via_str configuration variableto 3 for the request.
Diags header is requested, the XDebug plugin enables thetransaction specific diagnostics for the transaction. This also requiresthat proxy.config.diags.debug.enabled is set to 1.X-Cache-Key header contains the URL that identifies the HTTP object in theTraffic Server cache. This header is particularly useful if a custom cachekey is being used.The X-Cache header contains the results of any cache lookup.
| Value | Description |
|---|---|
| none | No cache lookup was attempted. |
| miss | The object was not found in the cache. |
| hit-stale | The object was found in the cache, but it was stale. |
| hit-fresh | The object was fresh in the cache. |
| skipped | The cache lookup was skipped. |
proxy.config.http.cache.generation configuration variable.X-Milestones header contains detailed information abouthow long the transaction took to traverse portions of the HTTPstate machine. The timing information is obtained from theTSHttpTxnMilestoneGet() API. Each milestone value is afractional number of seconds since the beginning of thetransaction.From Joomla! Documentation
- 1Edit PHP.INI File for XDebug
For Windows
Starting with version 1.7, XAMPP includes the XDebug PHP debugger, but it needs to be configured for use. To do that, we will edit the 'php.ini' file to configure XDebug. The 'Loaded Configuration File' in the screenshot above tells you what 'php.ini' file is being used. For Windows, this is normally 'c:xamppapachebinphp.ini'.
Important note for Windows 7 & Vista users: As of August 2013 (XAMPP version 1.8.2), the file 'php_xdebug.dll' that is included with XAMPP now works with Windows 7 & Vista. In some earlier versions of XAMPP, the distributed version of XDebug did not work correctly. The symptom of this earlier problem was that the Apache server would stop if this version of XDebug is loaded. To check that you are running the correct version of XDebug on your system, follow these instructions on the XDebug site.
We need to edit this file to configure XDebug as follows:
- Find the line 'implicit_flush' and set it as follows:
- Find the section called '[Zend]' and comment out all of the lines by putting a semi-colon (';') at the start of each line.
- Find the line: zend_extension = 'c:xamppphpextphp_xdebug.dll' and uncomment it out.
- Find the '[XDebug]' section and uncomment out all of the lines (except for the first comment line). For Windows, it should look like the example below:
You do not need to enable XDebug profiling to use XDebug to debug Joomla code. Profiling allows you to find performance bottlenecks in your PHP code. However, enabling profiling with XDebug can slow down your system substantially, so it is not recommended unless you need it. To enable XDebug profiling, add these entries to your php.ini file.
For Windows 7 & Vista, you will use the file downloaded from the XDebug site. So the first line will be
For PHP version 5.3 or later, the '_ts' has been dropped, so the first line will read
In XAMPP 1.7.3 on Windows 7 (currently not verified/tested with prior Windows versions), XDebug may not work correctly if the path to the DLL file is in quotes. In this case, the line should be
For Linux
We will edit the php.ini file to configure XDebug. The Loaded Configuration File in your phpinfo display tells you what php.ini file is being used. For Linux, it will be something like /etc/php/7.2/apache2/php.ini. (The PHP configuration is available in the Administrator of your Website: Administrator > System > System Information > PHP Information tab.)
Edit this file to configure XDebug as follows:
- Find the line implicit_flush and set it as follows:
- Add the following lines at the end:
If using php5-xdebug on Ubuntu The xDebug Configuration detailed above can be appended to:
It should already contain the zend_extension variable and only needs the following variables added:
Tip for users with LAN or remote servers:
Should be set to the IP address of your Eclipse workstation [LAN users] or your public IP. For example:
For Mac OS X
XAMPP for Mac OS X includes the XDebug PHP debugger, but it needs to be added to the 'php.ini' file so that XDebug runs when Apache is started. To do this, open up the php.ini file, located at '/Applications/XAMPP/xamppfiles/etc/php.ini'.
We need to edit this file to configure XDebug as follows:
- Find the line 'implicit_flush' and set it as follows:
- Add the following lines at the end:
Be sure to navigate to the directory where you targeted the extension and check to see that the file path is correct. The folders in your XAMPP installation may be named differently.
The current (as of Sept 2010) version of the XAMPP binary for OS X contains the 2.0.4 version of Xdebug which will not let you see the variable data from included files when running xdebug. You can download a newer version from http://code.activestate.com/komodo/remotedebugging/. Unzip and copy one of the xdebug.so files to /Applications/XAMPP/xamppfiles/lib/php/php-5.3.1/extensions/no-debug-non-zts-20090626. As of Oct 2, 2010 this binary is still out of date (2.1beta3 rather than the stable 2.1) but it will show the variable data appropriately.
Test XDebug Installation
Now, we need to check that XDebug is installed correctly. To do this, we need to re-start XAMPP. In Windows, we can just browse to the 'c:xampp' folder in Windows Explorer and double-click the program 'xampp-control.exe' to open the application shown below.
Press the 'Stop' button for 'Apache'. The button with then read 'Start'. Press 'Start' for Apache and wait a few seconds and the green 'Running' message will again display. Then press 'Exit' to close the application.
In Windows, if you get 'ERROR: MySQL service not started [-1]', you may be able to correct this by going to c:xamppmysql and running mysql_uninstallservice.bat followed by mysql_installservice.bat.
In Linux, to restart XAMPP execute the command
In Mac, open the 'XAMPP Control' application, stop, and then start the Apache service again.
Once XAMPP has been restarted, open a browser and navigate to 'http://localhost' to display the XAMPP welcome message (if you set XAMPP to listen to another port, you must append the port to the url; e.g.:'http://localhost:8080/'). Press the 'phpinfo()' link again to display the PHP information screen. Scroll down to the lower part of the screen. You should see a section for 'XDebug' as shown below.
Look at the settings you entered in the 'php.ini' file above. You should see these same settings in the xdebug display, as shown below.
At this point, XDebug is set up correctly.
Apache Debug Mode