ddev-xhgui

• Introduction
• Warning
• Getting started
• Usage
• Configuration

Introduction

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

XhGui is a graphical interface for XHProf profiling data that stores its results the 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 and restart your project

  ddev add-on get ddev/ddev-xhgui && ddev restart

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:

ddev logs -s xhgui

Configuration

To configure Xhgui, add .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