ndrx/profiler

Simple profiler package

profiler

![Software License][ico-license] ![Quality Status][ico-scrutinizer] , _(*1)

, _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require ndrx-io/profiler, <sub>(*4)</sub>

## Usage

### Initialize a profiler

``` php
// build a new profiler
$profiler = ProfilerFactory::build([
    ProfilerFactory::OPTION_ENABLE => true,
    ProfilerFactory::OPTION_DATASOURCE_PROFILES_FOLDER => '/tmp',
    ProfilerFactory::OPTION_COLLECTORS => [
        \Ndrx\Profiler\Collectors\Data\PhpVersion::class,
        \Ndrx\Profiler\Collectors\Data\CpuUsage::class,
        \Ndrx\Profiler\Collectors\Data\Context::class,
        \Ndrx\Profiler\Collectors\Data\Timeline::class,
        \Ndrx\Profiler\Collectors\Data\Request::class,
        \Ndrx\Profiler\Collectors\Data\Log::class,
        \Ndrx\Profiler\Collectors\Data\Duration::class,
        // add other data collector ...
    ],

    /**
    * Ndrx\Profiler\Components\Logs\Monolog
    * or Ndrx\Profiler\Components\Logs\Simple available
    **/
    ProfilerFactory::OPTION_LOGGER => \Ndrx\Profiler\Components\Logs\Monolog::class
]);

// initialize the profiler
$profiler->initiate();

Add event to the timeline

``` php $profiler->start('foo', 'Bar'); $profiler->stop('foo'); $this->profiler->monitor('Foobar', function() { // very long process });, <sub>(*5)</sub>

### Logger

``` php
$profiler->debug('No beer');
$profiler->info('No beer');
$profiler->notice('No beer');
$profiler->alert('No beer');
$profiler->error('No beer');
$profiler->emergency('No beer');
$profiler->critical('No beer');

Get last profils

``` php $profiles = $profiler->getDatasource()->all(0, 10);, <sub>(*6)</sub>

### Get Profil details

``` php
$id = '1576efef8ea36c74b533238affc3eaec7f94561d';
$profile = $profiler->getProfile($id);

Clear all data

``` php $profile = $profiler->getDatasource()->clear();, <sub>(*7)</sub>

### Use monolog handler

``` php
$profiler = ProfilerFactory::build([
    // ...
    ProfilerFactory::LOGGER => Ndrx\Profiler\Components\Logs\Monolog::class
]);

// $log is your instance of Monolog\Logger
$log->pushHandler($profiler->getLogger();

Add new Collector

All data collector must implements one of those interfaces:, <sub>(*8)</sub>

• Ndrx\Profiler\Collectors\Contracts\FinalCollectorInterface For data available only at the end of the process, like response data
• Ndrx\Profiler\Collectors\Contracts\StartCollectorInterface For data available at the beginning of the process, like request data
• Ndrx\Profiler\Collectors\Contracts\StreamCollectorInterface For data available during the process like logs, events, query...

Initial collector

``` php <?php, <sub>(*9)</sub>

namespace /Your/Namespace;, <sub>(*10)</sub>

use Ndrx\Profiler\Collectors\Collector; use Ndrx\Profiler\Collectors\Contracts\StartCollectorInterface;, <sub>(*11)</sub>

class Foo extends Collector implements StartCollectorInterface { /** * Fetch data * @return mixed */ public function resolve() { $this->data = 'bar'; }, <sub>(*12)</sub>

/**
 * The path in the final json
 * @example
 *  path /aa/bb
 *  will be transformed to
 *  {
 *     aa : {
 *              bb: <VALUE OF RESOLVE>
 *       }
 *  }
 * @return string
 */
public function getPath()
{
    return 'foo';
}

}, <sub>(*13)</sub>

### Final collector

``` php
<?php

namespace /Your/Namespace;

use Ndrx\Profiler\Collectors\Collector;
use Ndrx\Profiler\Collectors\Contracts\FinalCollectorInterface;

class Foo extends Collector implements FinalCollectorInterface
{
    /**
     * Fetch data
     * @return mixed
     */
    public function resolve()
    {
        $this->data = 'bar';
    }

    /**
     * The path in the final json
     * @example
     *  path /aa/bb
     *  will be transformed to
     *  {
     *     aa : {
     *              bb: <VALUE OF RESOLVE>
     *       }
     *  }
     * @return string
     */
    public function getPath()
    {
        return 'foo';
    }
}

Stream collector

Stream collector are a little bit more complex because you need to listen events and stream the event data to the datasource., <sub>(*14)</sub>

``` php <?php, <sub>(*15)</sub>

namespace Ndrx\Profiler\Collectors\Data;, <sub>(*16)</sub>

use Ndrx\Profiler\Collectors\StreamCollector; use Ndrx\Profiler\Events\Log as LogEvent; use Ndrx\Profiler\JsonPatch;, <sub>(*17)</sub>

class Log extends StreamCollector {, <sub>(*18)</sub>

protected function registerListeners()
{
    // add a listener to your event dispatcher, the profiler has a build-in dispatcher than use can use
    $this->process->getDispatcher()->addListener(LogEvent::EVENT_NAME, function (LogEvent $event) {
        // fetch event data
        $this->data = $event->toArray();
        // stream to the data source
        $this->stream();
    });
}

/**
 * The path in the final json
 * @example
 *  path /aa/bb
 *  will be transformed to
 *  {
 *     aa : {
 *              bb: <VALUE OF RESOLVE>
 *       }
 *  }
 * @return mixed
 */
public function getPath()
{
    return 'logs';
}

/**
 * Write data in the datasource and clean current buffer
 * @return mixed
 */
public function stream()
{
    // generation of the json patch from data
    $patch = $this->jsonPatch->generate($this->getPath(), JsonPatch::ACTION_ADD, $this->data, true);
    // save the json patch in the datasource
    $this->dataSource->save($this->process, [$patch]);
    // clean data array to avoid duplicate entry
    $this->data = [];
}

}, <sub>(*19)</sub>

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*20)</sub>

Security

If you discover any security related issues, please email arnaud.lahaxe[at]versusmind.eu instead of using the issue tracker., <sub>(*21)</sub>

Credits

• LAHAXE Arnaud
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*22)</sub>