/ddev-xhgui

XHGui service for a DDEV project

Primary LanguagePHPApache License 2.0Apache-2.0

tests project is maintained

ddev-xhgui

Introduction

This addon adds the XHGui service to a project served by DDEV.

XhGui is a graphical interface for XHProf profiling data that can store the results in MongoDB or PDO database.

See https://performance.wikimedia.org/xhgui/ 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.

Getting started

  • Install the ddev-xhgui add-on:

    ddev get tyler36/ddev-xhgui
ddev restart

Framework configuration

Drupal

  • Install perftools/php-profiler

    ddev composer require perftools/php-profiler --dev

  • Add the following line to web/sites/default/settings.php to include the collector.

    if (file_exists("/mnt/ddev_config/xhgui/collector/xhgui.collector.php")) {
 require_once "/mnt/ddev_config/xhgui/collector/xhgui.collector.php";
}

  • Run ddev xhprof to start profiling.

    • XHGui is now available at https://yourproject.ddev.site:8142

WordPress

  • Install perftools/php-profiler

    ddev composer require perftools/php-profiler --dev
    • If using vanilla WordPress:
    wget https://github.com/perftools/php-profiler/archive/refs/tags/0.18.0.tar.gz
tar -xvf 0.18.0.tar.gz

  • Add the following line to wp-config-ddev.php to include the collector.

    require_once __DIR__ . '/php-profiler-0.18.0/autoload.php';
if (file_exists("/mnt/ddev_config/xhgui/collector/xhgui.collector.php")) {
  require_once "/mnt/ddev_config/xhgui/collector/xhgui.collector.php";
}

  • Remove #ddev-generated from wp-config-ddev.php to prevent DDEV overriding it.

  • Run ddev xhprof to start profiling

    • XHGui is now available at https://yourproject.ddev.site:8142

Silverstripe

  • Install perftools/php-profiler

    ddev composer require perftools/php-profiler --dev

  • Add the following line to public/index.php, right after the autoload includes, to include the collector.

    if (file_exists(__DIR__ . '/../vendor/autoload.php')) {
  require __DIR__ . '/../vendor/autoload.php';
} elseif (file_exists(__DIR__ . '/vendor/autoload.php')) {
    require __DIR__ . '/vendor/autoload.php';
} else {
    header('HTTP/1.1 500 Internal Server Error');
    echo "autoload.php not found";
    exit(1);
}
if (file_exists("/mnt/ddev_config/xhgui/collector/xhgui.collector.php")) {
 require_once "/mnt/ddev_config/xhgui/collector/xhgui.collector.php";
}

  • Run ddev xhprof to start profiling

    • XHGui is now available at https://yourproject.ddev.site:8142

Usage

The service will automatically start when run: ddev start or ddev restart.

By default, xhgui will be available at https://yourproject.ddev.site:8143. Use the following command to launch the xhgui in your browser:

ddev xhgui

For detailed information about a single request, click on the "Method" keyword on the "Recent runs" dashboard.

Click GET method

Remember, if you updated settings.ddev.php or wp-config-ddev.php, these file will be overwritten unless you remove the #ddev-generated.

Use the following command to check the logs:

ddev logs -s xhgui

Configuration

To configure Xhgui, update .ddev/xhgui/xhgui.config.php.

For example, to set xhgui to use Asia/Toyko timezone for dates:

  • Remove #ddev-generated from .ddev/xhgui/xhgui.config.php

  • Change the timezone value

      'timezone' => 'Asia/Tokyo',
  'date.format' => 'Y-m-d H:i:s',

Contributed and maintained by @tyler36 based on the original ddev-contrib PR by @penyaskito