nedix/xhgui repository overview

⁠xhgui-container⁠

Web GUI for XHProf profiling reports.

⁠Usage with the PHP stack

The stack requires that you have a compose.yml for your PHP application's services (such as nginx, php-fpm, database, redis, etc.). The stack will publish ports on localhost for NGINX (proxy for XHProf on port 8081) and XHGui (port 8082).

⁠1. Create the Compose manifest

wget https://raw.githubusercontent.com/nedix/xhgui-container/main/stacks/php/compose-xhgui.yml

⁠2. Configure (optional)

export XHGUI_NGINX_PUBLIC_DIRECTORY=public

⁠3. Start the services

docker compose -f compose.yml -f compose-xhgui.yml up -d

⁠4. Create a profiling report

Navigate to your application on http://127.0.0.1:8081⁠ to create a profiling report.

⁠5. Import the profiling report into XHGui

Run the following command to load the data into XHGui:

docker compose exec xhgui php /var/www/xhgui/external/import.php -f /data/xhprof/xhgui.data.jsonl

⁠6. Gain insight into performance metrics

Navigate to the XHGui web interface on http://127.0.0.1:8082⁠.