{"id":1345,"date":"2018-01-19T19:22:44","date_gmt":"2018-01-19T19:22:44","guid":{"rendered":"http:\/\/goofy-trucks.flywheelsites.com\/profiling-php-code-with-xdebug-and-kcachegrind\/"},"modified":"2018-01-19T19:24:43","modified_gmt":"2018-01-19T19:24:43","slug":"profiling-php-code-with-xdebug-and-kcachegrind","status":"publish","type":"post","link":"https:\/\/phpbuilder.com\/profiling-php-code-with-xdebug-and-kcachegrind\/","title":{"rendered":"Profiling PHP Code with Xdebug and KCacheGrind"},"content":{"rendered":"
\n
\n
By W. Jason Gilmore<\/div>\n
on December 30, 2010<\/div>\n<\/p><\/div>\n
\n
In his 1974 paper, “Structured Programming with go to Statements”, famed computer scientist Donald Knuth<\/a> famously proclaimed premature optimization to be “the root of all evil.” While it is indeed a good idea to avoid spending too much time on code optimization during the early stages of any project, eventually you’ll want to seek out and resolve any bottlenecks in order to ensure your application is operating at its full potential.<\/div>\n
Which brings us to the question of how to even go about determining which parts of an application could conceivably be optimized. One common approach involves using a profiler such as Xdebug<\/a>, which can analyze your code and produce performance reports. These reports can then be reviewed within a profiling visualization tool such as KCacheGrind<\/a>.<\/div>\n
In this article I’ll show you how to use Xdebug and KCacheGrind to begin profiling and analyzing your PHP-driven Web applications.<\/div>\n

Installing Xdebug<\/h2>\n
Xdebug<\/a> is a powerful open source PHP debugging and profiling tool. Although you’re free to compile Xdebug from source, the easiest installation approach involves using PECL:<\/div>\n
<\/p>\n
%>pecl install xdebug<\/pre>\n
<\/code><\/div>\n
Once installed, add the following lines to your php.ini<\/code> file:<\/div>\n
<\/p>\n
zend_extension=\"\/full\/path\/to\/xdebug.so\"\nxdebug.profiler_enable = 1\nxdebug.profiler_output_dir = \/var\/www\/xdebug\/\nxdebug.profile_output_name = cachegrind.out.%t-%s<\/pre>\n
<\/code><\/div>\n
Of course, you may want to change the xdebug.profiler_output_dir<\/code> setting to a more desirable location. After saving the php.ini<\/code> file, restart Apache in order for the changes to take effect.<\/div>\n
Keep in mind that this will cause profile reports to be created every time a PHP script is run on this Web server. If you want to profile scripts selectively, add the following line to your php.ini<\/code> file:<\/div>\n
<\/p>\n
xdebug.profiler_enable_trigger=On<\/pre>\n
<\/code><\/div>\n
After restarting Apache, you’ll be able to profile scripts selectively by appending ?XDEBUG_PROFILE=1<\/code> to your URL.<\/div>\n
Installing KCacheGrind<\/h2>\n
KCacheGrind<\/a> is available for installation from within most operating systems’ software repositories. For instance, if you’re running Ubuntu you can install KCacheGrind using the following command:<\/div>\n
<\/p>\n
%>sudo apt-get install kcachegrind<\/pre>\n
<\/code><\/div>\n
If you’re running Windows, check out WinCacheGrind<\/a>.<\/div>\n
Creating a Profile Report<\/h2>\n
With Xdebug and KCacheGrind installed, you can begin profiling your PHP scripts. If you opted not to enable the xdebug.profiler_enable_trigger<\/code> configuration directive, then a new report will be created every time you execute a PHP script from within your browser. Each time you do so, a file will be created within the designated reporting directory, which looks like cachegrind.out.1447<\/code>. The contents of this file aren’t intended for human consumption, but rather should be passed to an analysis tool such as KCacheGrind.<\/div>\n
Loading the report into KCacheGrind opens a world of insight in terms of your ability to know for certain which operations are the most expensive. For instance, consider the output presented in Figure 1, which presents the call stack for a Zend Framework- and Doctrine<\/a>-driven project I’m currently working on.<\/div>\n

\n

Click here for larger image<\/em><\/font><\/a>
\n
Figure 1.<\/strong> Viewing a Zend Framework Action Call Stack<\/font><\/div>\n
I’ve sorted the execution time of each call in order to determine which calls are the most expensive. The call to the Default_Model_Platform<\/code> model’s hot()<\/code> method ranks up towards the top, and because I know this data changes only every few hours, now I can safely cache it and thereby eliminate this expensive database query (which is indeed a fairly large JOIN<\/code> operation). After implementing caching I again profile the page and indeed have eliminated that expensive call altogether (see Figure 2).<\/div>\n

\n

Click here for larger image<\/em><\/font><\/a>
\n
Figure 2.<\/strong> Caching Removes the Expensive Query Altogether<\/font><\/div>\n<\/div>\n
<\/p>\n
\n
1<\/div>\n
| <\/div>\n
2<\/a> <\/div>\n
Next Page \u00bb<\/a><\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
Learn how to use Xdebug and KCacheGrind to begin profiling and analyzing your PHP-driven Web<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3],"tags":[],"class_list":["post-1345","post","type-post","status-publish","format-standard","hentry","category-tutorials"],"_links":{"self":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1345","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/comments?post=1345"}],"version-history":[{"count":1,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1345\/revisions"}],"predecessor-version":[{"id":2168,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1345\/revisions\/2168"}],"wp:attachment":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/media?parent=1345"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/categories?post=1345"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/tags?post=1345"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}