Skip to content

Latest commit

 

History

History
131 lines (99 loc) · 6.11 KB

README.md

File metadata and controls

131 lines (99 loc) · 6.11 KB
Raw

yii-xhprof

Simple extension to use XHProf with Yii Framework 1.x.

Can work together with yii2-debug extension (bundled with debug panel for it).

By default profile starts on onBeginRequest event and stops on onEndRequest event. You can change this behavior and manually start and stop profiler.

For license information check the LICENSE file.

Tested on Yii Framework v1.1.16.

Installation

This extension is available at packagist.org and can be installed via composer by following command:

composer require --dev stevad/yii-xhprof.

If you want to install this extension manually - copy sources to /protected/extensions directory.

Minimal configuration to enable profiler:

return array(
    'preload' => array(
        'xhprof'
    ),
    'components' => array(
        'xhprof' => array(
            'class' => 'ext.yii-xhprof.XHProfComponent', // if you install to protected/extensions
            'libPath' => '/full/path/to/xhprof_lib',
            'htmlReportBaseUrl' => 'http://url.path.to/xhprof_html',
        ),
    ),
);

If you want to add bundled debug panel to yii2-debug extension - update configuration next way:

return array(
    'components' => array(
        'debug' => array(
            // ... other debug config options ...
            'panels' => array(
                'xhprof' => array(
                    'class' => 'ext.yii-xhprof.XHProfPanel' // if you install to protected/extensions
                )
            )
        ),
    ),
);

Required XHProf files (library files - xhprof_lib and UI - xhprof_html) you can find in this GitHub repo.

Component configuration

Extension provide next configuration options for Yii component:

  • enabled - enable/disable profiler component.
  • reportPathAlias - path alias to the directory to store JSON file with previous profiler runs. Default: application.runtime.xhprof
  • maxReportsCount - number of profile reports to store. Default: 25.
  • manualStart - flag to manually start profiler from desired place. Default: false.
  • manualStop - flag to manually stop profiler from desired place. Default: false.
  • forceStop - flag to force stop profiler on onEndRequest event if manualStop is enabled and profiler is still running. Default: true.
  • triggerGetParam - name of the GET param to manually trigger profiler to start. Default: no value, profiler runs on each request.
  • showOverlay - flag to display overlay on page with links to report and callgraph result for current profiler run (if allowed). Not required to be true if you are using bundled panel for yii2-debug extension. Default: true.
  • libPathAlias - path alias to the directory with xhprof_lib contents if it is placed somewhere in your Yii project. This option has more priority than libPath.
  • libPath - direct filesystem path to the directory with xhprof_lib contents.
  • htmlReportBaseUrl - URL path to the directory with XHProf UI contents (xhprof_html). Default: /xhprof_html (assuming you have this folder inside your document root).
  • flagNoBuiltins - enable/disable XHPROF_FLAGS_NO_BUILTINS flag for profiler (XHProf constants). Default: true.
  • flagCpu - enable/disable XHPROF_FLAGS_CPU flag for profiler (XHProf constants). Default: false.
  • flagMemory - enable/disable XHPROF_FLAGS_MEMORY flag for profiler (XHProf constants). Default: true.
  • blacklistedRoutes - list of routes which profiler should ignore. Allowed wildcard * which means 'any alphanumeric value and one of this: /, ., _, -. Default: array('debug*') (to ignore requests to the debug extension pages).

XHProf class configuration

Component from extension use own developed simple wrapper for xhprof_enable / xhprof_disable functions: XHProf class. This class provide functionality to start/stop profiling, save reports and get URLs for reports with XHProf library by Facebook.

Available configuration options (applicable for configure method, see example below):

  • flagNoBuiltins - enable/disable XHPROF_FLAGS_NO_BUILTINS flag for profiler (XHProf constants). Default: true.
  • flagCpu - enable/disable XHPROF_FLAGS_CPU flag for profiler (XHProf constants). Default: false.
  • flagMemory - enable/disable XHPROF_FLAGS_MEMORY flag for profiler (XHProf constants). Default: true.
  • libPath - direct filesystem path to the directory with xhprof_lib contents.
  • htmlUrlPath - URL path to the directory with XHProf UI contents (xhprof_html).
  • runId - predefined value of identifier for current profiler run.
  • runNamespace - predefined value of namespace for current profiler run.

All options can be changed with setters (e.g. setFlagCpu(<value>)). For more details see the source code of the class.

Manual profiling

If you enable manual start (manualStart option) or stop (manualStop option) you can place code to start/stop profiler in any place of your code and be able to see report and callgraph result.

To manual start you need to write some kind of next code:

// create and configure instance of XHProf class
XHProf::getInstance()->configure(array(
    'flagNoBuiltins' => true,
    'flagCpu' => false,
    'flagMemory' => true,
    'runNamespace' => 'my-cool-namespace',
    'libPath' => '/var/www/html/xhprof/xhprof_lib',
    'htmlUrlPath' => 'http://test.local/xhprof/xhprof_html'
));

// start profiler
XHProf::getInstance()->run();

To manual stop you need to write next code:

// stop profiler
XHProf::getInstance()->stop();

Note: If you use XHProf class (with or without this extension) - all profile results can be found on XHProf UI page (it's by default by xhprof developers).

Author

Copyright (c) 2015 by Stevad.