PHP Profiler
A PHP profiling library to submit profilings to XHGui.
Supported profilers:
- Tideways XHProf v5.x: PHP >= 7.0
- XHProf: PHP >= 5.3, PHP >= 7.0
- Tideways v4.x: PHP >= 7.0
- UProfiler: PHP >= 5.3, < PHP 7.0
This profiling library will auto-detect any supported profiler and use that.
The specific profiler can be chosen by profiler
config key.
Goals
- Compatibility with PHP >= 5.3.0
- No dependencies aside from the relevant extensions
- Customizable and configurable so you can build your own logic on top of it
Usage
In order to profile your application, you need to:
- Install this package
- Install profiler extension
- Instantiate the profiler
- Configure saver to send data to XHGui
Installation
The supported way to install this package is via composer:
composer require perftools/php-profiler
Create profiler
Creating profiler would be something like this:
<?php
// Add this block inside some bootstrapper or other "early central point in execution"
try {
/**
* The constructor will throw an exception if the environment
* isn't fit for profiling (extensions missing, other problems)
*/
$profiler = new \Xhgui\Profiler\Profiler($config);
// The profiler itself checks whether it should be enabled
// for request (executes lambda function from config)
$profiler->start();
} catch (Exception $e){
// throw away or log error about profiling instantiation failure
}
If you need to disable profiler doing flush
, session_write_close
and
fastcgi_finish_request
at the end of profiling, pass false
to register
shutdown handler:
$profiler->start(false);
Using config file
You can create config/config.php
and load config from there:
- copy
config/config.default.php
toconfig/config.php
- use
Config::create()
tonew Profiler
// Config::create() will load config/config.default.php
// and then merge with config/config.php (if it exists).
$config = \Xhgui\Profiler\Config::create();
$profiler = new \Xhgui\Profiler\Profiler($config);
Advanced Usage
You might want to control capture and sending yourself, perhaps modify data before sending.
/** @var \Xhgui\Profiler\Profiler $profiler */
// start profiling
$profiler->enable($flags, $options);
// run program
foo();
// stop profiler
$profiler_data = $profiler->disable();
// send $profiler_data to saver
$profiler->save($profiler_data);
Autoloader
To be able to profile autoloader, this project provides autoload.php
that
loads classes needed to start up the profiler.
Load it before loading composer autoloader:
require_once '/path/to/your/project/vendor/perftools/php-profiler/autoload.php';
$profiler = new \Xhgui\Profiler\Profiler($config);
$profiler->start();
require_once '/path/to/your/project/vendor/autoload.php';
Loading composer autoloader is still needed when saving results to MongoDB or PDO directly.
Config
Reference config of what can be configured:
It includes all configuration options and inline documentation about the options.
Savers
To deliver captured data to XHGui, you will need one of the savers to submit to the datastore XHGui uses.
- Stack saver
- Upload saver
- File saver
- MongoDB Saver (deprecated)
- PDO Saver (deprecated)
- Custom Saver Custom saver
Stack saver
Allows saving to multiple handlers.
The example config configures to use Upload Saver, and if that fails, save to File Saver:
'save.handler' => \Xhgui\Profiler\Profiler::SAVER_STACK,
'save.handler.stack' => array(
'savers' => array(
\Xhgui\Profiler\Profiler::SAVER_UPLOAD,
\Xhgui\Profiler\Profiler::SAVER_FILE,
),
// if saveAll=false, break the chain on successful save
'saveAll' => false,
),
// subhandler specific configs
'save.handler.file' => array(
'filename' => '/tmp/xhgui.data.jsonl',
),
'save.handler.upload' => array(
'url' => 'https://example.com/run/import',
'timeout' => 3,
'token' => 'token',
),
Upload saver
This is the recommended saver as it's the easiest to set up.
Example config:
'save.handler' => \Xhgui\Profiler\Profiler::SAVER_UPLOAD,
// Saving profile data by upload is only recommended with HTTPS
// endpoints that have IP whitelists applied.
'save.handler.upload' => array(
'url' => 'https://example.com/run/import',
// The timeout option is in seconds and defaults to 3 if unspecified.
'timeout' => 3,
// the token must match 'upload.token' config in XHGui
'token' => 'token',
),
File saver
If your site cannot directly connect to your XHGui instance, you can choose to save your data to a temporary file for a later import to XHGui.
Example config:
'save.handler' => \Xhgui\Profiler\Profiler::SAVER_FILE,
'save.handler.file' => array(
// Appends jsonlines formatted data to this path
'filename' => '/tmp/xhgui.data.jsonl',
),
To import a saved files, use XHGui's provided external/import.php
script.
MongoDB Saver
NOTE: Saving directly to MongoDB is discouraged, use Upload/File/Stack saver instead.
For saving directly to MongoDB you would need ext-mongo for PHP 5
and ext-mongodb with alcaeus/mongo-php-adapter package for PHP 7
along with perftools/xhgui-collector
package:
for PHP 5:
pecl install mongo
composer require perftools/xhgui-collector
for PHP 7:
pecl install mongodb
composer require perftools/xhgui-collector alcaeus/mongo-php-adapter
Example config:
'save.handler' => \Xhgui\Profiler\Profiler::SAVER_MONGODB,
'save.handler.mongodb' => array(
'dsn' => 'mongodb://127.0.0.1:27017',
'database' => 'xhprof',
// Allows you to pass additional options like replicaSet to MongoClient.
// 'username', 'password' and 'db' (where the user is added)
'options' => array(),
// Allows you to pass driver options like ca_file to MongoClient
'driverOptions' => array(),
),
PDO Saver
NOTE: Saving directly to PDO is discouraged, use Upload/File/Stack saver instead.
PDO Saver should be able to save to any PDO driver connection.
You will need to install additionally perftools/xhgui-collector
package:
composer require perftools/xhgui-collector
Example config:
'save.handler' => \Xhgui\Profiler\Profiler::SAVER_PDO,
'save.handler.pdo' => array(
'dsn' => 'sqlite:/tmp/xhgui.sqlite3',
'user' => null,
'pass' => null,
'table' => 'results'
),
Custom Saver
You can create your own profile saver by implementing SaverInterface
and calling setSaver()
.
use Xhgui\Profiler\Profiler;
use Xhgui\Profiler\Saver\SaverInterface;
class StdOutSaver implements SaverInterface
{
public function isSupported()
{
return true;
}
public function save(array $data)
{
fwrite(STDOUT, json_encode($data));
}
}
//...
/** @var Profiler $profiler */
$profiler->setSaver(new StdOutSaver());
Configure Profiling Rate
You may want to change how frequently you profile the application. The
profiler.enable
configuration option allows you to provide a callback
function that specifies the requests that are profiled.
The following example configures to profile 1 in 100 requests, excluding
requests with the /blog
URL path:
'profiler.enable' => function() {
$url = $_SERVER['REQUEST_URI'];
if (strpos($url, '/blog') === 0) {
return false;
}
return mt_rand(1, 100) === 42;
},
In contrast, the following example instructs to profile every request:
'profiler.enable' => function() {
return true;
},
Profile using XHProf helper
If you want to start profiling using a browser based tool like XHProf helper, You can use this method:
'profiler.enable' => function() {
return !empty($_COOKIE['_profiler']);
// or
return !empty($_COOKIE['XHProf_Profile']);
},
Configure 'Simple' URLs Creation
This library generates 'simple' URLs for each profile collected. These URLs are
used to generate the aggregate data used on the URL view. Since different
applications have different requirements for how URLs map to logical blocks of
code, the profile.simple_url
configuration option allows you to provide
the logic used to generate the simple URL.
By default, all numeric values in the query string are removed.
'profile.simple_url' => function($url) {
return preg_replace('/=\d+/', '', $url);
},
Configure ignored functions
You can use the profiler.options
configuration value to set additional options
for the profiler extension. This is useful when you want to exclude specific
functions from your profiler data:
'profiler.options' => array(
'ignored_functions' => array(
'call_user_func',
'call_user_func_array',
),
),
);
In addition, if you do not want to profile all PHP built-in functions,
Add ProfilingFlags::NO_BUILTINS
, to 'profiler.flags'.
Installing profilers
For this library to capture profiling data, you would need any of the profiler extension. Depending on your environment (PHP version), you may need to install different extension.
Supported profilers:
- Tideways XHProf v5.x: PHP >= 7.0
- XHProf: PHP >= 5.3, PHP >= 7.0
- Tideways v4.x: PHP >= 7.0
- UProfiler: PHP >= 5.3, < PHP 7.0
Tideways XHProf (5.+)
Tideways XHProf v5.x requires PHP >= 7.0.
To install tideways_xhprof
extension, see their installation documentation.
Alternatively on brew
(macOS) you can use packages from kabel/pecl tap:
brew install kabel/pecl/[email protected]
brew install kabel/pecl/[email protected]
brew install kabel/pecl/[email protected]
For outdated php versions few recipes exist in glensc/tap tap:
brew install glensc/tap/[email protected]
XHProf
XHProf supports all PHP versions.
xhprof
0.9.x requires PHP >= 5.3, < PHP 7.0xhprof
2.x requires PHP >= 7.0
for PHP 5.x:
pecl install xhprof-0.9.4
for PHP >=7.0:
pecl install xhprof
Alternatively on brew
(macOS) you can use packages from kabel/pecl tap:
brew install kabel/pecl/[email protected]
brew install kabel/pecl/[email protected]
brew install kabel/pecl/[email protected]
Tideways (4.x)
Tideways 4.x extension requires with PHP >= 7.0.
To install tideways
extension, see their installation documentation.
curl -sSfL https://github.com/tideways/php-xhprof-extension/archive/v4.1.6.tar.gz | tar zx
cd php-xhprof-extension-4.1.6/
phpize
./configure
make
make install
echo extension=/usr/local/lib/php/pecl/20160303/tideways.so | tee /usr/local/etc/php/7.1/conf.d/ext-tideways.ini
UProfiler
UProfiler requires PHP >= 5.3, < PHP 7.0
To install uprofiler
extension, see their installation documentation.