duhon/xhgui repository overview

⁠Overview

This fork add ability to use xhgui as docker container Just use docker pull duhon/xhgui and docker pull mongo for link mongo to xhgui Or use docker-compose approach:

version: '3.2'
services:
  app:
    image: _YOUR_APP_
  mongodb:
    image: mongo
    ports:
      - "27017:27017"
  xhgui:
    image: duhon/xhgui
    depends_on:
      - mongodb
    ports:
      - "0.0.0.0:8088:80"

For pass data from tideways to xhgui just add tideways.ini to your Application

Below you can find default docs:

⁠How To Run

1. Make sure you have installed tideways php extension. If you haven't - go to tideways extension⁠ and install it.
2. Go to php.ini file and add above configuration for tideways;
3. Restart php-fpm and apache;
4. Make sure you have installed docker. If not - go to Docker⁠ and install it;
5. Make sure you have installed docker-compose. If not - go to Docker Compose⁠ and install it;
6. Save docker-compose file from above;
7. Run docker-compose up -d to start containers;
8. Your xhgui web interface must be available on 0.0.0.0:8088
9. Use auto_prepand_file⁠ to add file external/header.php to your application;
10. Run your application and check results on xhgui web interface.

⁠xhgui

A graphical interface for XHProf data built on MongoDB.

This tool requires that Tideways⁠ are installed. Tideways is a PHP Extension that records and provides profiling data. XHGui (this tool) takes that information, saves it in MongoDB, and provides a convenient GUI for working with it.

⁠Using Tideways Extension

The XHProf PHP extension is not compatible with PHP7.0+. Instead you'll need to use the tideways extension⁠.

Once installed, you can use the following configuration data:

[tideways]
extension="/path/to/tideways/tideways.so"
tideways.connection=unix:///usr/local/var/run/tidewaysd.sock
tideways.load_library=0
tideways.auto_prepend_library=0
tideways.auto_start=0
tideways.sample_rate=100

⁠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.