Xdebug: Documentation (original) (raw)

This section describes on how to install Xdebug.

How you install Xdebug depends on your system. There are the following possibilities:

You can also install Xdebug with the following legacy installation methods:

Installing on Linux #

Installing Xdebug with a package manager is often the fastest way. Depending on your distribution, run the following command:

Xdebug's latest version is 3.5.3.

For packages that have the PHP version in the package name, such as inphp**81**-php-xdebug3, you can substitute the PHP version with the one that matches the PHP version that you are running.

Linux distributions might be providing an old and/or outdated version. If the package manager installs a version that is no longer supported (see Supported Versions), please install Xdebug with PIE, or from sourceinstead.

Installing with PIE #

PIE is an installer for PHP extensions on Linux, macOS, and Windows. It builds on top of the Packagistecosystem, and the installer tool is modelled on Composer.

Linux

Install PIE, but also the required packages for building PHP extensions from source.

macOS

Install PIE via homebrew with brew install pie.

This will also install the required packages for compiling and installing Xdebug from source.

Windows

You only have to install PIE because it will download the pre-built Xdebug extension DLLs.

When PIE is available, you can install Xdebug with:

pie install xdebug/xdebug

If you are running macOS, Linux, or any Unix-like operating system, then PIE will first download the source code of the extension. Then it will configure, compile, and install the extension into the right directory.

On Windows, PIE will download the pre-built binaries from a GIT release.

In either situation, PIE will also attempt to enable Xdebug by creating an INI file (such as 90-xdebug.ini), or adding the correct line tophp.ini.

After PIE has installed Xdebug, you can start using its features.

Installing with PECL #

The PECL installation tool and PECL web site are deprecated. PIE (PHP Installer for Extensions) is the replacement for PECL. You can find the instructions forinstalling Xdebug with PIE above.

You can install Xdebug through PECL on Linux and on macOS with Homebrew available.

Prerequisites:

Run:

pecl install xdebug

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 to add a configuration line to load Xdebug. You can check whether it did by running php -v. If Xdebug shows up with a version number, than you're all set and you can configure Xdebug's other functions, such asStep Debugging, or Profiling.

If it is there, you can skip to the What's Next?section.

If pecl did not add the right line, skip to the Configure PHP section.

Issues on macOS #

On Apple M1 hardware, programs can either be compiled for the native M1/ARM64 architecture, or for the emulated x86_64 architecure. Sometimes there is a mismatch with the default and PECL will fail, or Xdebug won't load with a message such as:

PHP Warning: Failed loading Zend extension 'xdebug.so' (tried: /opt/homebrew/lib/php/pecl/20190902/xdebug.so (dlopen(/opt/homebrew/lib/php/pecl/20190902/xdebug.so, 9): no suitable image found. Did find: /opt/homebrew/lib/php/pecl/20190902/xdebug.so: mach-o, but wrong architecture /opt/homebrew/lib/php/pecl/20190902/xdebug.so: stat() failed with errno=22), /opt/homebrew/lib/php/pecl/20190902/xdebug.so.so (dlopen(/opt/homebrew/lib/php/pecl/20190902/xdebug.so.so, 9): image not found)) in Unknown on line 0

You can verify what your PHP's architecture is with:

file which php

If that says arm64e, then you need to run:

arch -arm64 sudo pecl install xdebug

And if it's x86_64, then you need to run:

arch -x86_64 sudo pecl install xdebug

1 On macOS, you should have PHP installed with Homebrew.

Installing on Windows #

The easiest way is to use PIEto install Xdebug on Windows. Please refer to the instructions above.

There are a few precompiled modules (DLLs) available for Windows as well, in case you want to do the installation by hand. These pre-built DLLs are for the non-debug version of PHP. You can get those at the download page. Follow these instructions to install Xdebug manually.

Installation From Source #

Obtain #

You can download the source of the latest stable release 3.5.3.

Alternatively you can obtain Xdebug from GIT:

git clone git://github.com/xdebug/xdebug.git

This will checkout the latest development version which is currently 3.6.0dev. This development branch might not always work as expected, 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 you with the correct file to download, and which paths to use.

You compile Xdebug separately from the rest of PHP. You need access to the scripts phpize and php-config. If your system does not have phpize and php-config, you will need to install the PHP development headers.

Debian users can do that with:

apt-get install php-dev

And RedHat and Fedora users with:

yum install php-devel

It is important that the source version matches the installed version as there are slight, but important, differences between PHP versions. Once you have access to phpize and php-config, take the following steps:

  1. If you downloaded a tarball, unpack it:
    tar -xzf xdebug-3.5.3.tgz
    You should notunpack the tarball inside the PHP source code tree. Xdebug is compiled separately, all by itself, as stated above.
  2. Change into the source directory:
    1. tarball: cd xdebug-3.5.3
    2. GIT clone: cd xdebug
  3. phpize
    If phpize is not in your path, please make sure that it is, by expanding the PATH environment variable. Make sure you use the phpize that belongs to the PHP version that you want to use Xdebug with. See this FAQ entry if you're having some issues with finding which phpize to use.
  4. ./configure --enable-xdebug
  5. make
  6. make install

Configure PHP #

  1. Find out which PHP ini file to modify.
    Run a script with the following to find all configuration files that PHP has loaded:
  2. Add the following line to this PHP ini file:
    zend_extension=xdebug
  3. Restart your webserver, or PHP-FPM, depending on what you are using.
  4. Verify that Xdebug is now loaded.
    Create a PHP page that calls xdebug_info(). If you request the page through the browser, it should show you an overview of Xdebug's settings and log messages.
    On the command line, you can also run php -v. Xdebug and its version number should be present as in:
    PHP 7.4.10 (cli) (built: Aug 18 2020 09:37:14) ( NTS DEBUG )
    Copyright (c) The PHP Group
    Zend Engine v3.4.0, Copyright (c) Zend Technologies
    with Zend OPcache v7.4.10-dev, Copyright (c), by Zend Technologies
    with Xdebug v3.0.0-dev, Copyright (c) 2002-2020, by Derick Rethans
    If Xdebug does not show up, or you get a warning from PHP that anxdebug.so file or similar was not found, you might need to use the full path instead of just zend_extension=xdebug, such aszend_extension=/usr/lib/php/20190902/xdebug.so.
    On Windows, you should place the php_xdebug.dll in theext/ directory, which is a child directory in your PHP installation tree.

If you have trouble with this, please refer to the installation wizard to help you guide through this process.

What's Next? #

With Xdebug loaded, you can now enable individual features, such asStep Debugging, or Profiling. Information on what these features are, how they work, and how to configure them is available on each feature's documentation page:

Related Content #

Related Settings and Functions #

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 sure that the system user that PHP runs at (such as www-data if you are running 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 concurrency protection available.

The log file will include any attempt that Xdebug makes to connect to an IDE:

[2693358] Log opened at 2020-09-02 07:19:09.616195 [2693358] [Step Debug] INFO: Connecting to configured address/port: localhost:9003. [2693358] [Step Debug] ERR: Could not connect to debugging client. Tried: localhost:9003 (through xdebug.client_host/xdebug.client_port). [2693358] [Profiler] ERR: File '/foo/cachegrind.out.2693358' could not be opened. [2693358] [Profiler] WARN: /foo: No such file or directory [2693358] [Tracing] ERR: File '/foo/trace.1485761369' could not be opened. [2693358] [Tracing] WARN: /foo: No such file or directory [2693358] Log closed at 2020-09-02 07:19:09.617510

It includes the opening time (2020-09-02 07:19:09.616195), the IP/Hostname and port Xdebug is trying to connect to (localhost:9003), and whether it succeeded (Connected to client). The number in brackets ([2693358]) is the Process ID.

It includes:

[2693358]

process ID in brackets

2020-09-02 07:19:09.616195

opening time

For Step Debugging:

INFO: Connecting to configured address/port: localhost:9003. ERR: Could not connect to debugging client. Tried: localhost:9003 (through xdebug.client_host/xdebug.client_port).

For Profiling:

ERR: File '/foo/cachegrind.out.2693358' could not be opened. WARN: /foo: No such file or directory

For Function Trace and Flame Graphs:

ERR: File '/foo/trace.1485761369' could not be opened. WARN: /foo: No such file or directory

All warnings and errors are described on the Description of errors page, with detailed instructions on how to resolve the problem, if possible. All errors are always logged through PHP's internal logging mechanism (configured with error_login php.ini). All warnings and errors also show up in the diagnostics 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 XML element:

The fileuri attribute lists the entry point of your application, which can be useful to compare to breakpoint_setcommands to see if path mappings are set-up correctly.

Beyond the <init element, you will find the configuration offeatures:

<- feature_set -i 4 -n extended_properties -v 1 ->

And continuation commands:

<- step_into -i 9 -> <xdebug:message filename="file:///home/httpd/www.xdebug.org/html/router.php" lineno="3">

You can read about DBGP - A common debugger protocol specification at its dedicated documation page.

The xdebug.log_level setting controls how much information is logged.

Many Linux distributions now use systemd, which implements private tmp directories. This means that when PHP is run through a web server or as PHP-FPM, the /tmp directory is prefixed with something akin to:/tmp/systemd-private-ea3cfa882b4e478993e1994033fc5feb-apache.service-FfWZRg

This setting can additionally be configured through theXDEBUG_CONFIG environment variable.

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.

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 the diagnostics log that you can view by calling xdebug_info().

Criticals and errors are additionally logged through PHP'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 or files like 99-xdebug.ini that are read when a PHP process starts (directly, or through php-fpm). You can not set this value in.htaccess and .user.ini files, which are read per-request, nor through php_admin_value as used in Apache VHOSTs and PHP-FPM pools.

The following values are accepted:

off

Nothing is enabled. Xdebug does no work besides checking whether functionality is enabled. Use this setting if you want close to 0 overhead.

develop

Enables Development Helpers including the overloaded var_dump().

coverage

Enables Code Coverage Analysis to generate code coverage reports, mainly in combination withPHPUnit.

debug

Enables Step Debugging. This can be used to step through your code while it is running, and analyse values of variables.

gcstats

Enables Garbage Collection Statistics to collect statistics about PHP's Garbage Collection Mechanism.

profile

Enables Profiling, with which you can analyse performance bottlenecks with tools like KCacheGrind.

trace

Enables the Function Trace and Flame Graphs features.

The former allows you record every function call, including arguments, variable assignment, and return value that is made during a request to a file.

The latter can be used to visualise certain performance characteristics.

You can enable multiple modes at the same time by comma separating their identifiers as value to xdebug.mode: xdebug.mode=develop,trace.

XDEBUG_MODE environment variable

You can also set Xdebug's mode by setting the XDEBUG_MODEenvironment variable on the command-line; this will take precedence over thexdebug.mode setting, but will not change the value of the xdebug.modesetting.

Some web servers have a configuration option to prevent environment variables from being propagated to PHP and Xdebug.

For example, PHP-FPM has a clear_envconfiguration setting that is on by default, which you will need to turn off if you want to use XDEBUG_MODE.

Make sure that your web server does not clean the environment, or specifically allows the XDEBUG_MODE environment variable to be passed on.

Functions #

xdebug_info( string $category = null ) : mixed #

Show and retrieve diagnostic information

This function presents APIs to retrieve information about Xdebug itself. Which information gets returned, or displayed, depends on which arguments, or none at all, are given.

$category =

Without arguments, 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 theDescription of errors documentation page.

$category = 'mode' (New in Xdebug 3.1)

The function returns an array of all the enabled modes, whether through xdebug.mode or theXDEBUG_MODE environment variable.

Example:

<?php
var_dump( xdebug_info( 'mode' ) );
?>

Returns:

array(3) { [0] => string(5) "debug" [1] => string(7) "develop" [2] => string(5) "trace" }

$category = 'extension-flags' (New in Xdebug 3.1)

The function returns an array of all the compile flags that were enabled when running ./configure as part of Xdebug's compilation process, and all the system-specific detected features that effect Xdebug's behaviour.

If the compression flag is enabled, then the xdebug.use_compression setting is available, and enabled by default.

Profiling and Function Trace will create GZip compressed files if thexdebug.use_compression setting is turned on (the default).

If the control-socket and tsc elements are present, then Xdebug can be controlled with the Xdebug Control tool, as long asxdebug.control_socket is not set to "off".

If the control-socket flag is present, but the tsc flag is not present, then you must set xdebug.control_socket to"time" deliberately for Xdebug Control to be able to interact with Xdebug.

Example:

<?php
var_dump( xdebug_info( 'extension-flags' ) );
?>

Returns:

array(1) { [0] => string(11) "compression" [1] => string(14) "control-socket" [2] => string(3) "tsc" }