ob-ivan / sd-profiler

v1.3 2018-02-15 09:34 UTC

Requires

• firephp/firephp-core: ^0.4.0

Requires (Dev)

• phpunit/phpunit: ^7.0

Unknown License

Published on Packagist.org on 2018-02-15 09:36 UTC

README

Allows you to tag your code with profiler frames. It will calculate inclusive and exclusive durations for each tag and output with selected strategies.

Installation

composer require ob-ivan/sd-profiler

Init

To start profiling and select output strategies:

profiler()->init([
    'append' => true,
    // or:
    'firephp' => true,
);
register_shutdown_function(function () {
    profiler()->dispatch();
});

Example from WordPress functions.php:

if (isset($_COOKIE['secretcookie']) && $_COOKIE['secretcookie'] === 'secretvalue') {
    profiler()->init([
        'firephp' => true,
    ]);
    // Dispatch profiling result before WP forcefully closes all output buffers.
    add_action(
        'shutdown',
        function () {
            profiler()->dispatch();
        },
        0
    );
}

Usage

To put profiler frame tags:

profiler()->in('my_function', $vars);
my_function($vars);
profiler()->out('my_function');

You can add arbitrary debug info with log method:

function my_function($vars) {
    profiler()->log('my_function', $vars);
    // useful stuff here...
}