This small profiler is a library that is supposed to be similar to the Stack Exchange mvc-mini-profiler for the ASP .NET MVC framework.
php isn't always as eloquent as other languages, and as-such, some things don't translate 100%. However, this is a good start.
What does it profile?
It will profile any block of code that you want to profile. It automatically nests and keeps track of time in the current step level, as well as child levels. It doesn't automatically attach itself to anything, so you can profile as much or as little as you like.
There are special provisions for profiling SQL, but that isn't being leveraged (currently) to do much other than 1. see how much sql is being executed at any step, and 2. how long it takes.
Great, how the heck do I use it?
Glad you asked! It's simple!
To profile a block of code:
<?php require 'profiler.php'; Profiler::enable(); $profBlock = Profiler::start('my block'); sleep(1); $profBlock->end(); ?>
You can also accomplish the same thing without keeping track of the reference to the current step block, like this:
<?php require 'profiler.php'; Profiler::enable(); Profiler::start('my block'); sleep(1); Profiler::end('my block'); ?>
The caveat to method #2 is that your strings must match, so it's easy to overlook a small spelling mistake. However, if the strings don't match, you'll get a PHP warning telling you as such.
To profile an sql query:
<?php //we'll assume you have the profiler included and enabled now.. you only need to require it one time for any project. $queryProf = Profiler::sqlStart($query); //make sure you pass your query. that way the profile can analyze it and let you know which queries are being slow $db->query($query); $queryProf->end(); ?>
To output the results, so you can, uh, see them:
Include the following code in your view, template, output, or whatever it is that you may be using to generate output
<?php Profiler::render(); ?>
That's it! You'll now be able to spot optimizationaly troubled spots of your application!
Profiler::enable();call is intended to be called conditionally. You are absolutely not going to want to have the profiler running full-time in your production environment. That'd clearly be an overly high waste of resources! Only enable profiling when you actually need to see how things are going. Pro Tip: Enable profiling conditionally based on your requesting IP address, or some other authentication system. This way profiling will always be turned on for you, and never for your visitors.
Profiler::render();method automatically ends every block in the stack so it can accurately output the time it spent in each block as best it can. (Basically, if you wanted to profile your view, you'd have no way to see how much time it took to render the view, if the view profile block was ended after output was generated.).
Profiler::render();method accepts a
$max_depthparameter which allows you to tell the renderer not to render any steps beyond the maximum depth passed. Default is -1, which means "give it all to me!"
- You can "skip" ending child blocks by just ending a parent block. You can do this by calling
Profiler::end();with the name of the parent block you want to end. This will close every child block (regardless of name) until it reaches the parent. This does produce warnings! Be Careful! You can go all the way to the root level by accidentally referencing a parent node incorrectly!
Put bugs into issues, and feel free to fork + submit pull requests for any new features/bug fixes/etc.
Copyright (C) 2012 Jim Rubenstein email@example.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.