https://github.com/ddev/ddev-xhgui
XHGui web interface for XHProf profiling
https://github.com/ddev/ddev-xhgui
ddev-get
Last synced: about 1 year ago
JSON representation
XHGui web interface for XHProf profiling
- Host: GitHub
- URL: https://github.com/ddev/ddev-xhgui
- Owner: ddev
- License: apache-2.0
- Created: 2023-03-29T06:56:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T11:21:22.000Z (about 1 year ago)
- Last Synced: 2025-04-06T02:25:30.155Z (about 1 year ago)
- Topics: ddev-get
- Language: Shell
- Homepage:
- Size: 105 KB
- Stars: 16
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ddev/ddev-xhgui/actions/workflows/tests.yml?query=branch%3Amain)
[](https://github.com/ddev/ddev-xhgui/commits)
[](https://github.com/ddev/ddev-xhgui/releases/latest)
# DDEV XHGui (obsolete and archived)
This add-on is a part of DDEV since [v1.24.4](https://github.com/ddev/ddev/releases/tag/v1.24.4). Use the regular `ddev xhgui` feature to use it, see [docs](https://ddev.readthedocs.io/en/stable/users/debugging-profiling/xhprof-profiling/#simplest-xhprof-usage-with-xhgui) and [XHGui Feature Makes Profiling Even Easier](https://ddev.com/blog/xhgui-feature).
This add-on is archived.
## Overview
[XHGui](https://github.com/perftools/xhgui) is a graphical interface for XHProf profiling data that stores its results the database.
This add-on integrates XHGui into your [DDEV](https://ddev.com/) project.
See for an demonstration of XHGui data collection.
## Warning
This addon is for debugging in a development environment.
Profiling in a production environment is not recommended.
## Installation
```sh
ddev add-on get ddev/ddev-xhgui
ddev restart
```
After installation, make sure to commit the `.ddev` directory to version control.
## Usage
When you want to start profiling, `ddev xhprof on`.
The web profiling UI is at `https://yourproject.ddev.site:8143` or use `ddev xhgui` to launch it.
For detailed information about a single request, click on the "Method" keyword on the "Recent runs" dashboard.
To check the xhgui service's logs:
```sh
ddev logs -s xhgui
```
## Advanced Customization
To configure XHGui, add `.ddev/xhgui/xhgui.config.php`.
For example, to set xhgui to use `Asia/Tokyo` timezone for dates:
- Remove `#ddev-generated` from `.ddev/xhgui/xhgui.config.php`
- Change the timezone value
```php
'timezone' => 'Asia/Tokyo',
'date.format' => 'Y-m-d H:i:s',
```
## Credits
**Contributed and maintained by [@tyler36](https://github.com/tyler36) based on the original [ddev-contrib PR](https://github.com/ddev/ddev-contrib/pull/128) by [@penyaskito](https://github.com/penyaskito)**