PHPackages perftools/xhgui - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. perftools/xhgui ActiveLibrary perftools/xhgui =============== A web based interface for viewing profile data collected by XHProf 0.23.6(10mo ago)1.7k115.3k—0%343[13 PRs](https://github.com/perftools/xhgui/pulls)MITJavaScriptPHP ^8.0CI passing Since Apr 4Pushed 4mo ago65 watchersCompare [ Source](https://github.com/perftools/xhgui)[ Packagist](https://packagist.org/packages/perftools/xhgui)[ RSS](/packages/perftools-xhgui/feed)WikiDiscussions 0.24.x Synced 1mo ago READMEChangelog (10)Dependencies (9)Versions (63)Used By (0) XHGui ===== [](#xhgui) A graphical interface for XHProf profiling data that can store the results in MongoDB or PDO database. Application is profiled and the profiling data is transferred to XHGui, which takes that information, saves it in MongoDB (or PDO database), and provides a convenient GUI for working with it. This project is the GUI for showing profiling results, to profile your application, use specific minimal library: - [perftools/php-profiler](#profiling-a-web-request-or-cli-script) [![Build Status](https://camo.githubusercontent.com/6fbab3c65b05262b3755e7cfbb76a6ed0444dcdf28280589e053e9b7adddbac3/68747470733a2f2f7472617669732d63692e6f72672f70657266746f6f6c732f78686775692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/perftools/xhgui)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/c3db632f29fc67713d92af39e92d10a32ee30d79b7d07ea6cc27f7dbcda376c6/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f70657266746f6f6c732f78686775692f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/perftools/xhgui/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/f3945a36bffcd46cb8519cb39c246218fc763dbd559492ad364e3587d1217a9a/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f70657266746f6f6c732f78686775692f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/perftools/xhgui/?branch=master) System Requirements =================== [](#system-requirements) XHGui has the following requirements: - Known to work: PHP 8.0-8.3 - If using MongoDB storage, see [MongoDB](#MongoDB) requirements - If using PDO storage, see [PDO](#PDO) requirements - To profile an application, one of the profiling PHP extensions is required. See [Profiling a Web Request or CLI script](#profiling-a-web-request-or-cli-script). The extension is not needed to run XHGui itself. If you need to decide which backend to use, you can check the [compatibility matrix](#compatibility-matrix) what features are implemented or missing per backend. MongoDB ------- [](#mongodb) The default installation uses MongoDB database. Most of the documentation speaks about MongoDB. - [MongoDB Extension](https://pecl.php.net/package/mongodb) MongoDB PHP driver: `pecl install mongodb`XHGui requires version 1.3.0 or later. - [MongoDB](https://www.mongodb.com/) MongoDB Itself. XHGui requires version 3.2 or later. PDO --- [](#pdo) - [PDO](https://www.php.net/manual/en/book.pdo.php) PHP extension Any of the drivers and an accompanying database: - [SQLite (PDO)](https://www.php.net/manual/en/ref.pdo-sqlite.php) - [MySQL (PDO)](https://www.php.net/manual/en/ref.pdo-mysql.php) - [PostgreSQL (PDO)](https://www.php.net/manual/en/ref.pdo-pgsql.php) NOTE: PDO may not support all the features of XHGui, see [\#320](https://github.com/perftools/xhgui/issues/320). Installation from source ======================== [](#installation-from-source) 1. Clone or download `xhgui` from GitHub. 2. Point your webserver to the `webroot` directory. 3. Set the permissions on the `cache` directory to allow the webserver to create files. If you're lazy, `0777` will work. The following command changes the permissions for the `cache` directory: ``` chmod -R 0777 cache ``` 4. Start a MongoDB instance. XHGui uses the MongoDB instance to store profiling data. 5. If your MongoDB setup uses authentication, or isn't running on the default port and localhost, update XHGui's `config/config.php` so that XHGui can connect to your `mongod` instance. 6. (**Optional**, but recommended) Add indexes to MongoDB to improve performance. XHGui stores profiling information in a `results` collection in the `xhprof` database in MongoDB. Adding indexes improves performance, letting you navigate pages more quickly. To add an index, open a `mongo` shell from your command prompt. Then, use MongoDB's `db.collection.ensureIndex()` method to add the indexes, as in the following: ``` $ mongo > use xhprof > db.results.ensureIndex( { 'meta.SERVER.REQUEST_TIME' : -1 } ) > db.results.ensureIndex( { 'profile.main().wt' : -1 } ) > db.results.ensureIndex( { 'profile.main().mu' : -1 } ) > db.results.ensureIndex( { 'profile.main().cpu' : -1 } ) > db.results.ensureIndex( { 'meta.url' : 1 } ) > db.results.ensureIndex( { 'meta.simple_url' : 1 } ) > db.results.ensureIndex( { 'meta.SERVER.SERVER_NAME' : 1 } ) ``` 7. Install dependencies with composer ``` composer install --no-dev ``` 8. Set up your webserver. The Configuration section below describes how to setup the rewrite rules for both nginx and apache. Installation with Docker ======================== [](#installation-with-docker) This setup uses [docker-compose](https://docs.docker.com/compose/) to orchestrate docker containers. 1. Copy example [`docker-compose.yml`](https://github.com/perftools/xhgui/raw/HEAD/docker-compose.yml) from this project 2. Startup the containers: `docker-compose up -d` 3. Open your browser at or just or type at terminal `composer open` 4. To customize xhgui, copy [`src/config.default.php`](https://github.com/perftools/xhgui/raw/HEAD/src/config.default.php) to `config/config.php` and edit that file. Configuration ============= [](#configuration) Configure Webserver Re-Write Rules ---------------------------------- [](#configure-webserver-re-write-rules) XHGui prefers to have URL rewriting enabled, but will work without it. For Apache, you can do the following to enable URL rewriting: 1. Make sure that an .htaccess override is allowed and that AllowOverride has the directive FileInfo set for the correct DocumentRoot. Example configuration for Apache 2.4: ``` Options Indexes FollowSymLinks AllowOverride FileInfo Require all granted ``` 2. Make sure you are loading up mod\_rewrite correctly. You should see something like: ``` LoadModule rewrite_module libexec/apache2/mod_rewrite.so ``` 3. XHGui comes with a `.htaccess` file to enable the remaining rewrite rules. For nginx and fast-cgi, you can use the following snippet as a start: ``` server { listen 80; server_name example.com; # root directive should be global root /var/www/example.com/public/xhgui/webroot/; index index.php; location / { try_files $uri $uri/ /index.php?$args; } location ~ \.php$ { try_files $uri =404; include /etc/nginx/fastcgi_params; fastcgi_pass 127.0.0.1:9000; fastcgi_index index.php; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; } } ``` Profiling a Web Request or CLI script ===================================== [](#profiling-a-web-request-or-cli-script) The supported way to profile an application is to use [perftools/php-profiler](https://github.com/perftools/php-profiler)package. You can use that package to collect data from your web application or a CLI script. This data is then pushed into XHGui database where it can be viewed with XHGui application. The `php-profiler` package offers submitting data directly to XHGui instance once the profiling is complete at the end of the request. If the application cannot directly connect to XHGui instance, the package offers solution to capture profiling data to a file which you can import later using the [import](https://github.com/perftools/php-profiler#import-jsonl-files) script. **Warning**: Importing the same file twice will create duplicate profiles. Limiting MongoDB Disk Usage --------------------------- [](#limiting-mongodb-disk-usage) Disk usage can grow quickly, especially when profiling applications with large code bases or that use larger frameworks. To keep the growth in check, configure MongoDB to automatically delete profiling documents once they have reached a certain age by creating a [TTL index](http://docs.mongodb.org/manual/core/index-ttl/). Decide on a maximum profile document age in seconds: you may wish to choose a lower value in development (where you profile everything), than production (where you profile only a selection of documents). The following command instructs Mongo to delete documents over 5 days (432000 seconds) old. ``` $ mongo > use xhprof > db.results.ensureIndex( { "meta.request_ts" : 1 }, { expireAfterSeconds : 432000 } ) ``` Waterfall Display ----------------- [](#waterfall-display) The goal of XHGui's waterfall display is to recognize that concurrent requests can affect each other. Concurrent database requests, CPU-intensive activities and even locks on session files can become relevant. With an Ajax-heavy application, understanding the page build is far more complex than a single load: hopefully the waterfall can help. Remember, if you're only profiling a sample of requests, the waterfall fills you with impolite lies. Some Notes: - There should probably be more indexes on MongoDB for this to be performant. - The waterfall display introduces storage of a new `request_ts_micro` value, as second level granularity doesn't work well with waterfalls. - The waterfall display is still very much in alpha. - Feedback and pull requests are welcome :) Monitoring ========== [](#monitoring) [Prometheus](https://prometheus.io) metrics suitable for monitoring service health are exposed on `/metrics`. (This currently only works if using PDO for storage.) Compatibility matrix ==================== [](#compatibility-matrix) FeatureMongoDBPDOPrometheus exporter✗✓ [\#305](https://github.com/perftools/xhgui/pull/305)Searcher::latest()✓✓Searcher::query()✓✗ [\#384](https://github.com/perftools/xhgui/pull/384)Searcher::get()✓✓Searcher::getForUrl()✓✓ [\#436](https://github.com/perftools/xhgui/pull/436)Searcher::getPercentileForUrl()✓✓ [\#436](https://github.com/perftools/xhgui/pull/436)Searcher::getAvgsForUrl()✓✗ [\#384](https://github.com/perftools/xhgui/pull/384)Searcher::getAll(sort)✓✓ [\#436](https://github.com/perftools/xhgui/pull/436)Searcher::getAll(direction)✓✓ [\#436](https://github.com/perftools/xhgui/pull/436)Searcher::delete()✓✓Searcher::truncate()✓✓Searcher::saveWatch()✓✓ [\#435](https://github.com/perftools/xhgui/pull/435)Searcher::getAllWatches()✓✓ [\#435](https://github.com/perftools/xhgui/pull/435)Searcher::truncateWatches()✓✓ [\#435](https://github.com/perftools/xhgui/pull/435)Searcher::stats()✗ [\#305](https://github.com/perftools/xhgui/pull/305)✓Searcher::getAllServerNames()✓ [\#460](https://github.com/perftools/xhgui/pull/460)✗Releases / Changelog ==================== [](#releases--changelog) See the [releases](https://github.com/perftools/xhgui/releases) for changelogs, and release information. License ======= [](#license) Copyright (c) 2013 Mark Story & Paul Reinheimer Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ### Health Score 61 — FairBetter than 99% of packages Maintenance66 Regular maintenance activity Popularity58 Moderate usage in the ecosystem Community38 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~57 days Recently: every ~2 days Total 54 Last Release 307d ago PHP version history (6 changes)0.8.0PHP >=5.3.0 0.10.0PHP ^5.6 || ^7.0 0.13.0PHP ^7.0 0.18.0PHP ^7.2 || ^8.0 0.20.1PHP ^7.2 || ~8.0 || ~8.1 0.23.2PHP ^8.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/32449?v=4)[Glen Noronha](/maintainers/glen)[@glen](https://github.com/glen) ![](https://www.gravatar.com/avatar/1efd7167fe426440c421f477c4e808464bc244dea2f5a9786c94db60732f0870?d=identicon)[markstory](/maintainers/markstory) ![](https://www.gravatar.com/avatar/c134ad824ba652ebc95fb07cb2fdf50a89c587a846557626972a0dc901a7638e?d=identicon)[lauripiisang](/maintainers/lauripiisang) --- Top Contributors [![glensc](https://avatars.githubusercontent.com/u/199095?v=4)](https://github.com/glensc "glensc (721 commits)")[![markstory](https://avatars.githubusercontent.com/u/24086?v=4)](https://github.com/markstory "markstory (682 commits)")[![preinheimer](https://avatars.githubusercontent.com/u/244891?v=4)](https://github.com/preinheimer "preinheimer (58 commits)")[![1ma](https://avatars.githubusercontent.com/u/1456708?v=4)](https://github.com/1ma "1ma (25 commits)")[![Krinkle](https://avatars.githubusercontent.com/u/156867?v=4)](https://github.com/Krinkle "Krinkle (19 commits)")[![Mte90](https://avatars.githubusercontent.com/u/403283?v=4)](https://github.com/Mte90 "Mte90 (16 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (15 commits)")[![bertrandmalet](https://avatars.githubusercontent.com/u/496453?v=4)](https://github.com/bertrandmalet "bertrandmalet (12 commits)")[![dumityty](https://avatars.githubusercontent.com/u/1616746?v=4)](https://github.com/dumityty "dumityty (11 commits)")[![sebbrandt87](https://avatars.githubusercontent.com/u/793580?v=4)](https://github.com/sebbrandt87 "sebbrandt87 (7 commits)")[![beberlei](https://avatars.githubusercontent.com/u/26936?v=4)](https://github.com/beberlei "beberlei (5 commits)")[![PierrePaul](https://avatars.githubusercontent.com/u/149291?v=4)](https://github.com/PierrePaul "PierrePaul (5 commits)")[![thbourlove](https://avatars.githubusercontent.com/u/1768066?v=4)](https://github.com/thbourlove "thbourlove (5 commits)")[![lornajane](https://avatars.githubusercontent.com/u/172607?v=4)](https://github.com/lornajane "lornajane (4 commits)")[![lauripiisang](https://avatars.githubusercontent.com/u/5603529?v=4)](https://github.com/lauripiisang "lauripiisang (3 commits)")[![anho](https://avatars.githubusercontent.com/u/863612?v=4)](https://github.com/anho "anho (3 commits)")[![david-garcia-garcia](https://avatars.githubusercontent.com/u/9599352?v=4)](https://github.com/david-garcia-garcia "david-garcia-garcia (3 commits)")[![dshafik](https://avatars.githubusercontent.com/u/58074?v=4)](https://github.com/dshafik "dshafik (3 commits)")[![kornrunner](https://avatars.githubusercontent.com/u/725986?v=4)](https://github.com/kornrunner "kornrunner (3 commits)")[![ossinkine](https://avatars.githubusercontent.com/u/2588533?v=4)](https://github.com/ossinkine "ossinkine (3 commits)") --- Tags ext-mongodbext-pdomongodbphpprofilerprofiling-dataxhguixhprof ### Embed Badge ![Health badge](/badges/perftools-xhgui/health.svg) ``` [![Health](https://phpackages.com/badges/perftools-xhgui/health.svg)](https://phpackages.com/packages/perftools-xhgui) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[contao/core-bundle Contao Open Source CMS 1231.6M2.4k](/packages/contao-core-bundle)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 595.2M386](/packages/shopware-core)[laynefyc/xhgui-chinese From perftools/xhgui,A web based interface for viewing profile data collected by XHProf. 8931.9k](/packages/laynefyc-xhgui-chinese) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)