Apache Xdebug
This section describes on how to install Xdebug.
@GabbyTee I almost can say I do love you haha. Since I modified xdebug after it didn't work I just have done a fresh install and changed the lines I did three thousand times before (the ones you told me), and got the correct answer with phpinfo.
- How to install Xdebug on Ubuntu. Xdebug is a powerfull tool for debugging PHP. It can display formated errors and embed the usefull ```vardump``` function. This page explains how to install and configure Xdebug. Step by step installation on a Cloud9 server.
- Release date: 2021-04-08. Linux, macOS: source; Windows binaries: PHP 7.2 VC15 (64 bit) PHP 7.2 VC15 (32 bit) PHP 7.2 VC15 TS (64 bit) PHP 7.2 VC15 TS (32 bit) PHP 7.3 VC15 (64 bit) PHP 7.3 VC15 (32 bit) PHP 7.3 VC15 TS (64 bit) PHP 7.3 VC15 TS (32 bit) PHP 7.4 VC15 (64 bit).
- How you install Xdebug depends on your system. There are the following possibilities: Linux with a package manager such as apt, yum, or something else. Linux without an Xdebug package with PECL.
How you install Xdebug depends on your system. There are the following possibilities:
- Linux with a package manager such as
apt
,yum
, or something else. - Linux without an Xdebug package with PECL.
- macOSX with homebrew, through PECL.
- Windows, with help from a wizard.
- Unix-like operating systems, from source.
Installing on Linux #
Installing Xdebug with a package manager is often the fastest way. Depending on your distribution, run the following command:
- Alpinelinux:
sudo apk add php7-pecl-xdebug
- Arch Linux:
sudo pacman -S xdebug
- CentOS:
sudo yum install php-xdebug
- CentOS (Remi Repro):
sudo yum install php74-php-xdebug
- Debian (9/stretch, testing/buster/bullseye/sid):
sudo apt-get install php-xdebug
- Fedora (32):
sudo yum install php-xdebug
- Fedora (Remi Repro):
sudo yum install php74-php-xdebug
- Gentoo:
emerge dev-php/xdebug
- Manjaro (20.1/Mikah):
sudo pacman -S xdebug
- RHEL:
sudo yum install php-xdebug
- RHEL (Remi Repro):
sudo yum install php74-php-xdebug
- SUSE (openSUSE, Enterprise):
sudo zypper in php7-xdebug
- Ubuntu (18.04 LTS/Bionic, 20.04 LTS/Focal):
sudo apt-get install php-xdebug
- Ubuntu (Ondřej Surý's PPA):
sudo apt-get install php7.4-xdebug
Linux distributions might be providing an old and/or outdated version.If the package managerinstalls a version that is no longer supported (see Supported Versions), please installXdebug with PECL, or from sourceinstead.
Xdebug's latest version is 3.0.4.
Installing with PECL #
You can install Xdebug through PECL on Linux & macOS with Homebrew.Run:
On Apple M1 hardware, you might instead need to use:
Warning: You should ignore any prompts to add'extension=xdebug.so'
tophp.ini
— this will cause problems.
In some cases pecl
will change the php.ini
file toadd a configuration line to load Xdebug. You can check whether it did byrunning php -v
. If Xdebug shows up with a version number, thanyou're all set and you can configure Xdebug's other functions, such asStep Debugging, or Profiling.
If pecl
did not add the right line, skip to the Configure PHP section.
1 On macOS, you should have PHP installed with Homebrew.
Installing on Windows #
There are a few precompiled modules for Windows, they are all for the non-debugversion of PHP. You can get those at the downloadpage. Follow these instructions to get Xdebuginstalled.
Installation From Source #
Obtain #
You can download the source of the latest stable release 3.0.4.
Alternatively you can obtain Xdebug from GIT:
This will checkout the latest development version which is currently3.1.0-dev. This development branch might not always work asexpected, and may have bugs.
You can also browse the source on GitHub at https://github.com/xdebug/xdebug.
Compile #
There is a wizard available that provides youwith the correct file to download, and which paths to use.
You compile Xdebug separately from the rest of PHP. You need access to thescripts phpize
and php-config
. If your systemdoes not have phpize
and php-config
, you willneed to install the PHP development headers.
Debian users can do that with:
And RedHat and Fedora users with:
It is important that the source version matches the installed version as thereare slight, but important, differences between PHP versions. Once you haveaccess to phpize
and php-config
, take thefollowing steps:
Unpack the tarball:
tar -xzf xdebug-3.0.4.tgz
You should notunpack the tarball inside the PHP source code tree.Xdebug is compiled separately, all by itself, as stated above.
cd xdebug-3.0.4
Acer 91.e4906.fz1 driver download for windows.phpize
If phpize is not in your path, please make surethat it is by expanding the
PATH
environment variable. Make sureyou use the phpize that belongs to the PHP version that you want to use Xdebugwith. See this FAQ entry if you're having someissues with finding which phpize to use../configure --enable-xdebug
make
make install
Configure PHP #
Add the following line to
php.ini
:zend_extension=/wherever/you/put/it/xdebug
Acer acerpower 8000 driver download. To find out which
php.ini
file to modify, run a script with thefollowing:Alternatively, you can run
php --ini
on the command line.Note: There could be more than one
php.ini
file. In many set-ups there is a different one for thecommand line (oftencli/php.ini
) and the web server (oftenfpm/php.ini
).Note: If you want to use Xdebug andOPCache together, you must have the
zend_extension
line for Xdebugbelow the line for OPCache. Otherwise, they won't work properly together.Restart your webserver, or PHP-FPM, depending on what you areusing.
Verify that Xdebug is now loaded.
Create a PHP page that calls xdebug_info(). If you request thepage through the browser, it should show you an overview of Xdebug's settingsand log messages.
On the command line, you can also run
php -v
. Xdebug and itsversion number should be present as in:
With Xdebug loaded, you can now enable individual features, such asStep Debugging, or Profiling.
Related Settings and Functions
- stringxdebug.log =
- integerxdebug.log_level = 7
- stringxdebug.mode = develop
- xdebug_info() : void
Settings
string xdebug.log = #
Configures Xdebug's log file.
Xdebug will log to this file all file creations issues, Step Debuggingconnection attempts, failures, and debug communication.
Enable this functionality by setting the value to a absolute path. Make surethat the system user that PHP runs at (such as www-data
if you arerunning with Apache) can create and write to the file.
The file is opened in append-mode,and will therefore not be overwritten by default. There is no concurrencyprotection available.
The log file will include any attempt that Xdebugmakes to connect to an IDE:
It includes the opening time (2020-09-02 07:19:09.616195
), theIP/Hostname and port Xdebug is trying to connect to(localhost:9003
), and whether it succeeded (Connected toclient :-)
). The number in brackets ([2693358]
) is theProcess ID.
It includes:
[2693358]
- process ID in brackets
2020-09-02 07:19:09.616195
- opening time
For Step Debugging:
For Profiling:
For Function Trace:
All warnings and errors are described on the Description of errors page, withdetailed instructions on how to resolve the problem, if possible. All errors are always logged throughPHP's internal logging mechanism (configured with error_login php.ini
). All warnings and errors also show up in thediagnostics log that you can view by calling xdebug_info().
Step Debugger Communication
The debugging log can also log the communication between Xdebug and an IDE.This communication is in XML, and starts with the <init
XMLelement:
The fileuri
attribute lists the entry point of yourapplication, which can be useful to compare to breakpoint_set
commands to see if path mappings are set-up correctly.
Beyond the <init
element, you will find the configuration offeatures:
And continuation commands:
You can read about DBGP - A common debugger protocol specification at its dedicated documation page.
The xdebug.log_level setting controls how much information islogged.
Note: Many Linux distributions now use systemd, whichimplements private tmp directories. This means that when PHPis run through a web server or as PHP-FPM, the /tmp
directory isprefixed with something akin to:
This setting can additionally be configured through theXDEBUG_CONFIG
environment variable.
Apache Debug Logging
integer xdebug.log_level = 7#
Configures which logging messages should be added to the log file.
The log file is configured with the xdebug.log setting.
Xdebug Apache Timeout
The following levels are supported:
Level | Name | Example |
---|---|---|
0 | Criticals | Errors in the configuration |
1 | Errors | Connection errors |
3 | Warnings | Connection warnings |
5 | Communication | Protocol messages |
7 | Information | Information while connecting |
10 | Debug | Breakpoint resolving information |
Criticals, errors, and warnings always show up in thediagnostics log that you can view by calling xdebug_info().
Criticals and errors are additionally logged throughPHP's internal logging mechanism (configured with error_login php.ini
).
This setting can additionally be configured through theXDEBUG_CONFIG
environment variable.
string xdebug.mode = develop#
This setting controls which Xdebug features are enabled.
This setting can only be set in php.ini
orfiles like 99-xdebug.ini
that are read when a PHP process starts(directly, or through php-fpm), but not in .htaccess
and.user.ini
files, which are read per-request.
The following values are accepted:
off
- Nothing is enabled. Xdebug does no work besides checking whetherfunctionality is enabled. Use this setting if you want close to 0overhead.
develop
- Enables Development Aids including the overloaded var_dump().
coverage
- Enables Code Coverage Analysis to generate code coverage reports, mainly incombination withPHPUnit.
debug
- Enables Step Debugging. This can be used to step through your code while itis running, and analyse values of variables.
gcstats
- Enables Garbage Collection Statistics to collect statistics about PHP's GarbageCollection Mechanism.
profile
- Enables Profiling, with which you can analyse performance bottleneckswith tools like KCacheGrind.
trace
- Enables the Function Trace feature, which allows you record every functioncall, including arguments, variable assignment, and return value that is madeduring a request to a file.
You can enable multiple modes at the same time by comma separating theiridentifiers as value to xdebug.mode: xdebug.mode=develop,trace
.
You can also set the mode by setting the XDEBUG_MODE
environmentvariable on the command-line; this will take precedence over the xdebug.mode setting, but will no change the value of the xdebug.mode setting.
Functions
xdebug_info() : void#
This function returns an HTML page which shows diagnostic information. It is analogous to PHP's phpinfo() function.
The HTML output includes which mode is active, what the settings are, and diagnostic information in case there are problems with debugging connections, opening of files, etc.
Each warning and error in the diagnostics log also links through to the Description of errors documentation page.