Skip to content
Permalink
Browse files

Fix #1911 (#140)

* Fix #1911

Varying-Vagrant-Vagrants/VVV#1911

* fix typos
  • Loading branch information
Mte90 committed Oct 10, 2019
1 parent 96c66d4 commit 577e6d863fdb7af43a7dd1876d87f6c32b725b5a
Showing with 12 additions and 7 deletions.
  1. +12 −7 docs/en-US/references/tideways.md
@@ -17,28 +17,33 @@ We added [XHGui](https://github.com/perftools/xhgui) that is a graphical interfa

## How to enable it

XHGui need a php file that is prepended to all of them (by a global php config) to turn on the profiling and save this information.
XHGui will be executed in headless mode if Tideways is available for the PHP version used in the website that you are profiling.
To profile a page you need to enable the tideways module and disable xDebug, you can do it running the `xdebug_off` command inside the Vagrant machine.
XHGui need a php file that is prepended to all of them (by a global php config) to turn on the profiling and save this information.

XHGui will be executed in headless mode if Tideways is available for the PHP version used in the website that you are profiling.

To profile a page you need to enable the tideways module and disable xDebug, you can do it running the `xdebug_off` command inside the Vagrant machine (in this way xDebug is turned off but Tidewyas is turned on).

Now Tideways is globally enabled and you can enable it in 2 ways:

* Specific URL: Add `?enable-tideways` to your URL
* Specific URL: Add `?enable-tideways=1` to your URL
* For the domain: Create a new parameter `tideways: true` in your `vvv-config.yml` and run a provision, like:

```
```yaml
sites:
wordpress-default:
repo: https://github.com/Varying-Vagrant-Vagrants/custom-site-template.git
tideways: true
```

Later you can check to `xhgui.vvv.test` the result from profiling.
Later you can check to `xhgui.vvv.test` the result from profiling.
The provisioning will generate a file with all the domains enabled in `/srv/config/tideways.json`.

## Our custom implementation

To improve the data quality we added the support to not execute `Query Monitor` plugin when Tideways is enabled.
Also we implemented the support for a custom PHP `custom-header.php` file in `VVV/www/default/xhgui/config` that will be prepended in case it is avalaible.
We added the support for a custom config file that can change the values of XHGui that will be merged with the VVV default.

We added the support for a custom config file `custom-config.php` in the same folder that can change the values of XHGui that will be merged with the VVV default. This can be helpful to filter via other methods, such as from the list like from specific plugins and so on.

## XHGui
There are already a lot of guides about XHGui:

0 comments on commit 577e6d8

Please sign in to comment.
You can’t perform that action at this time.