windwalker/profiler

Windwalker Profiler package

Windwalker Profiler

Windwalker Profiler can help us profiler some process information for debug., _(*1)

Installation via Composer

Add this to the require block in your composer.json., _(*2)

``` json { "require": { "windwalker/profiler": "~3.0" } }, <sub>(*3)</sub>

## Create A Profiler And Mark A Point

``` php
use Windwalker\Profiler\Profiler;

$profiler = new Profiler;

$profiler->mark('StartRender');

// Execute some code...

$profiler->mark('AfterRender');

// Execute some code...

$profiler->mark('End');

Now your can get the elapsed time between two points:, <sub>(*4)</sub>

``` php $profiler->getTimeBetween('StartRender', 'AfterRender');, <sub>(*5)</sub>

Or get memory amount between two points:

``` php
// Return memory bytes
$profiler->getMemoryBetween('StartRender', 'AfterRender');

Output Result

``` php echo $profiler->render();, <sub>(*6)</sub>

``` php
Notes 0.000 seconds (+0.000); 0.00 MB (+0.000) - StartRender
Notes 1.000 seconds (+1.000); 3.00 MB (+3.000) - AfterRender
Notes 1.813 seconds (+0.813); 6.24 MB (+3.240) - End

Benchmark

Benchmark is a convenience object to test two or more tasks executing time., <sub>(*7)</sub>

``` php use Windwalker\Profiler\Banchmark;, <sub>(*8)</sub>

$benchmark = new Benchmark;, <sub>(*9)</sub>

$benchmark->addTask('task1', function() { md5(uniqid()); }) ->addTask('task2', function() { sha1(uniqid()); });, <sub>(*10)</sub>

$benchmark->execute(10000);, <sub>(*11)</sub>

echo $benchmark->render();, <sub>(*12)</sub>

The output

task1 => 0.204897 s task2 => 0.205108 s, <sub>(*13)</sub>

Use Other format

``` php
$benchmark->setTimeFormat(Benchmark::MILLI_SECOND)->execute(10000);

echo $benchmark->render();

/* Result
task1 => 187.489986 ms
task2 => 207.049847 ms
*/

``` php $benchmark->setTimeFormat(Benchmark::MICRO_SECOND)->execute(10000);, <sub>(*14)</sub>

echo $benchmark->render();, <sub>(*15)</sub>

/* Result task1 => 198050.9758 μs task2 => 206343.173981 μs */, <sub>(*16)</sub>

### Custom Render Handler

``` php
$benchmark->setRenderOneHandler(function($name, $result, $round, $format)
{
    return $name . ' : ' . round($result, $round);
});

$benchmark->render();