Profiling PHP
Starting from Datakit Version-1.13.0, support for using dd-trace-php as an application performance monitoring tool for PHP projects is available.
Prerequisites¶
- Linux X64 with glibc 2.17+, Linux X64 with musl v1.2+
- PHP 7.1+ NTS (Non-Thread Safe)
Install dd-trace-php¶
Download the installation script datadog-setup.php and execute:
wget https://github.com/DataDog/dd-trace-php/releases/download/0.90.0/datadog-setup.php
php datadog-setup.php --enable-profiling
During the installation process, the script will automatically detect the paths of the php and php-fpm installed on the current system and ask you to select which programs need profiling. Enter the corresponding numbers as needed.
Searching for available php binaries, this operation might take a while.
Multiple PHP binaries detected. Please select the binaries the datadog library will be installed to:
1. php --> /usr/bin/php8.1
2. php8.1 --> /usr/bin/php8.1
3. php-fpm8.1 --> /usr/sbin/php-fpm8.1
Select binaries using their number. Multiple binaries separated by space (example: 1 3): 1 2 3
If you know the installation path of the current system's php or php-fpm, you can also specify the php path directly via the --php-bin parameter when executing the installation script. This can skip the detection and selection steps mentioned above, for example:
The installation process requires downloading the installation package from github.com. Depending on your network conditions, this may take some time. Please wait for the installation program to exit successfully. Afterwards, you can execute the command php --ri "datadog-profiling" to verify whether the installation was successful.
php --ri "datadog-profiling"
datadog-profiling
Version => 0.90.0
Profiling Enabled => true
Experimental CPU Time Profiling Enabled => true
Allocation Profiling Enabled => true
...
Note
As of the time of writing this document, Datakit supports up to dd-trace-php v0.90.0. Higher versions have not been systematically tested, and compatibility is unknown. If you encounter any issues during use, please feel free to contact us.
Start Profiling¶
Set the following environment variables when starting the PHP script:
DD_PROFILING_ENABLED=1 \
DD_PROFILING_ENDPOINT_COLLECTION_ENABLED=1 \
DD_PROFILING_ALLOCATION_ENABLED=1 \
DD_PROFILING_EXPERIMENTAL_CPU_TIME_ENABLED=1 \
DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=1 \
DD_PROFILING_LOG_LEVEL=info \
DD_SERVICE=my-php-cli-app \
DD_ENV=prod \
DD_VERSION=1.22.333 \
DD_AGENT_HOST=127.0.0.1 \
DD_TRACE_AGENT_PORT=9529 \
php <your-path-to>.php
In the PHP-FPM pool configuration directory pool.d (by default, there is only one configuration file www.conf), add the following environment variables to www.conf using the env directive:
Note
You can try using php-fpm -i | grep Configuration to confirm the location of the currently loaded php-fpm configuration files:
php-fpm8.1 -i | grep Configuration
Configuration File (php.ini) Path => /etc/php/8.1/fpm
...
ls -l /etc/php/8.1/fpm/pool.d
total 48
-rw-r--r-- 1 root root 20901 Aug 7 21:22 www.conf
php-fpm program is registered as a systemd service, you can also try using the command systemctl status php-fpm.service | grep .conf to view the current configuration file path:
systemctl status php8.1-fpm.service | grep .conf
Process: 629814 ExecStart=/usr/sbin/php-fpm8.1 --nodaemonize --fpm-config /etc/php/8.1/fpm/php-fpm.conf (code=exited, status=0/SUCCESS)
Process: 629818 ExecStartPost=/usr/lib/php/php-fpm-socket-helper install /run/php/php-fpm.sock /etc/php/8.1/fpm/pool.d/www.conf 81 (code=exited, status=0/SUCCESS)
Process: 630872 ExecStopPost=/usr/lib/php/php-fpm-socket-helper remove /run/php/php-fpm.sock /etc/php/8.1/fpm/pool.d/www.conf 81 (code=exited, status=0/SUCCESS)
...
...
; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from
; the current environment.
; Default Value: clean env
;env[HOSTNAME] = $HOSTNAME
;env[PATH] = /usr/local/bin:/usr/bin:/bin
;env[TMP] = /tmp
;env[TMPDIR] = /tmp
;env[TEMP] = /tmp
env[DD_PROFILING_ENABLED]=true
env[DD_PROFILING_ENDPOINT_COLLECTION_ENABLED]=true
env[DD_PROFILING_ALLOCATION_ENABLED]=true
env[DD_PROFILING_EXPERIMENTAL_CPU_TIME_ENABLED]=true
env[DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED]=true
env[DD_PROFILING_LOG_LEVEL]=info
env[DD_SERVICE]=my-fpm-app
env[DD_ENV]=dev
env[DD_VERSION]=1.2.33
env[DD_AGENT_HOST]=127.0.0.1
env[DD_TRACE_AGENT_PORT]=9529
Restart php-fpm and visit your project.
After a few minutes, you should be able to view the relevant data in the Guance Cloud Console.