bnomei/kirby3-stopwatch

Profile your Kirby 3 CMS code with precision in milliseconds (or seconds).

1.0.7 2023-04-20 07:15 UTC

Requires

• php: >=8.0
• getkirby/composer-installer: ^1.1
• symfony/stopwatch: ^5.0

Requires (Dev)

• getkirby/cms: ^3.2
• php-coveralls/php-coveralls: ^2.1
• phpunit/phpunit: ^8.3

Suggests

• bnomei/kirby3-janitor: Profile time spend in jobs
• bnomei/kirby3-monolog: Log profiling results to files/databases/notifications/...

MIT

• Bruno Meilick

• measure
• profile
• stopwatch
• milliseconds
• kirby3
• kirby3-cms
• kirby3-plugin
• usleep

README

Profile your Kirby CMS code with precision in milliseconds (or seconds).

Installation

• unzip master.zip as folder site/plugins/kirby3-stopwatch or
• git submodule add https://github.com/bnomei/kirby3-stopwatch.git site/plugins/kirby3-stopwatch or
• composer require bnomei/kirby3-stopwatch

Works well with

• Janitor Plugin
• Monolog Plugin

Usage Site Method

Please read the Symfony Stopwatch Component Docs since this plugin is just a soft wrapper around it. Some Examples:

Event Duration

site()->stopwatch()->start('myevent');
sleep(1);
site()->stopwatch()->stop('myevent');
echo site()->stopwatch()->duration('myevent') . PHP_EOL; // float | int

Event with Laps aka Periods

$eventName = 'my event with laps';
$stopwatch = site()->stopwatch();
$stopwatch->start($eventName);
foreach ([random_int(100,500),random_int(100,500),random_int(100,500)] as $time) {
    usleep($time);
    $stopwatch->lap($eventName);
}
usleep(100);
$stopwatch->stop($eventName);
$totalDuration = $stopwatch->duration($eventName); // float | int
echo $totalDuration . PHP_EOL;
foreach ($stopwatch->getEvent($eventName)->getPeriods() as $period) {
    echo $period->getDuration() . PHP_EOL;  // float | int
}

Usage PHP Class

You can use the provided php class in your own classes if you make sure the class is loaded before you call it. This can be done in installing this plugin using composer or in manually requiring it with Kirby's class loader.

$stopwatch = \Bnomei\Stopwatch::singleton();
$stopwatch->start('my event with laps');
sleep(1);
$stopwatch->stop('my event with laps');
$duration = $stopwatch->duration('my event with laps'); // float | int

Settings

NOTE: This plugin defaults to measuring in milliseconds but the symfony component does not.

Dependencies

• symfony/stopwatch

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.