README

A simple library for doing profiling without a need for thousands of external dependencies.

Installation

The simplest way to install it is to use Composer:

composer require ngranko/phprofiler

Or you can move the contents of this repository to a folder of your liking and then have a lot of fun making the autoloading work, etc.

Usage

Initialization

To use the library simply create a new PHProfiler object:

<?php
$profiler = new PHProfiler();

This will initialize the profiler and set current time and memory consumption values as reference to calculate relative time and memory usage against.

Capturing a point

To capture a point, do:

<?php
$profiler = new PHProfiler();
$profiler->rememberPoint();

This will capture a current state of the system: time elapsed and memory usage.

Exporting results

Depending on a type of export you want to do, do one of those:

<?php
$profiler = new PHProfiler();
$profiler->rememberPoint();
$profiler->export(ExporterType::LOG);

The first, required, argument to the export() function is a type of export you want to do. Use ExporterType constants to specify it and see which types are available.

By default, a file will be created in your current working directory, named profiler_output_[timestamp].[extension]. If you want to save result to some other place, simply specify a desired path (with a filename) as a second argument to the export() function.

ngranko / phprofiler

Maintainers

Details