Skip to content

Latest commit

 

History

History
110 lines (76 loc) · 4.23 KB

README.md

File metadata and controls

110 lines (76 loc) · 4.23 KB
Raw

README

What is XHProf?

XHProf is a hierarchical profiler for PHP. It reports function-level call counts and inclusive and exclusive metrics such as wall (elapsed) time, CPU time and memory usage. A function's profile can be broken down by callers or callees. The raw data collection component is implemented in C as a PHP Zend extension called xhprof. XHProf has a simple HTML based user interface (written in PHP). The browser based UI for viewing profiler results makes it easy to view results or to share results with peers. A callgraph image view is also supported.

See official documentation

What does this Symfony 2 Bundle do?

This bundle helps you to easily use the XHProf bundle with the web debug toolbar in Symfony 2.

Installation

Make sure you have XHProf installed. If you are on a mac you can easily install it via Macports sudo port install php5-xhprof

  1. Composer

Add the following dependencies to your projects composer.json file:

```json
"require": {
    # ..
    "jns/xhprof-bundle": "dev-master"
    # ..
}
```

  1. Old way by adding to your vendor/bundles/ dir

  2. To install the bundle, place it in the src/Jns/Bundle directory of your project

(so that it lives at src/Jns/Bundle/XhprofBundle). You can do this by adding the bundle as a submodule, cloning it, or simply downloading the source.

```shell
git submodule add https://github.com/jonaswouters/XhprofBundle.git src/Jns/Bundle/XhprofBundle
```

  1. Add the Jns namespace to your autoloader

If this is the first Jns bundle in your Symfony 2 project, you'll

need to add the Jns namespace to your autoloader. This file is usually located at app/autoload.php.

```php
$loader->registerNamespaces(array(
    'Jns' => __DIR__.'/../src'
    // ...
));
```

Initializing the bundle

To initialize the bundle, you'll need to add it in your kernel. This file is usually located at app/AppKernel.php. Loading it only in your dev environment is recommended.

public function registerBundles()
{
    // ...

    if (in_array($this->getEnvironment(), array('dev', 'test'))) {
        // ...
        $bundles[] = new Jns\Bundle\XhprofBundle\JnsXhprofBundle();
    }
)

Configure the XHProf locations.

The Bundle comes preconfigured for the macports php5-xhprof default installation, with the xhprof web located at http://xhprof.localhost. To change these settings for your environment you can override the defaults by defining the following settings in your config. The config is usually located at app/config/config_dev.yml.

jns_xhprof:
    location_lib:    /opt/local/www/php5-xhprof/xhprof_lib/utils/xhprof_lib.php
    location_runs:   /opt/local/www/php5-xhprof/xhprof_lib/utils/xhprof_runs.php
    location_config: /opt/local/www/php5-xhprof/xhprof_lib/config.php
    location_web:    http://xhprof.localhost
    enabled:         true

Using XHGui

XHGui is a GUI for the XHProf PHP extension, using a database backend, and pretty graphs to make it easy to use and interpret. The XHProf bundle supports using XHGui to display the results. To use, install XHGui, and add the following two settings to the configuration, usually located at app/config/config.yml:

jns_xhprof:
    entity_manager:  <name_of_entity_manager> (defaults to default)
    enable_xhgui:    true

If you only have one entity manager defined, you don't need to set it here. This setting is for the case where you are using a seperate profiling database for XHGui (highly recommended).

Specifying a Sample Size

You can specify a sample size for profiling. This is highly suggested for production environments that have plenty of requests. The sample size is set as a probability for profiling, so for example, if you set the sample size to 2, then on average, every second request will be profiled. Of course, in production you want to set it to a much higher value. Defaults to 1, so that every request will be profiled.

jns_xhprof:
    sample_size: 2