Download the PHP package aterrien/forp-profiler without Composer
On this page you can find all versions of the php package aterrien/forp-profiler. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aterrien/forp-profiler
More information about aterrien/forp-profiler
Files in aterrien/forp-profiler
Package forp-profiler
Short Description A PHP profiler written in C. forp is a lightweight PHP extension which provides the full call stack of your script, with CPU and memory usage, in a plain PHP Array or JSON output.
License MIT
Homepage https://github.com/aterrien/forp-PHP-profiler
Informations about the package forp-profiler
Introduction
forp is a lightweight PHP extension which provides PHP profile datas.
Summary of features :
- measurement of time and allocated memory for each function
- CPU usage
- file and line number of the function call
- output as Google's Trace Event format
- caption of functions
- grouping of functions
- aliases of functions (useful for anonymous functions)
forp is non intrusive, it provides PHP annotations to do its work.
Simple (almost the most complicated) example
Example :
Result :
Example with annotations
Example :
Result :
php.ini options
- forp.max_nesting_level : default 50
- forp.no_internals : default 0
forp PHP API
- forp_start(flags*) : start forp collector
- forp_end() : stop forp collector
- forp_dump() : return stack as flat array
- forp_print() : display forp stack (SAPI CLI)
forp_start() flags
- FORP_FLAG_TIME : activate collect of time
- FORP_FLAG_MEMORY : activate collect of memory usage
- FORP_FLAG_CPU : retrieve the cpu usage
- FORP_FLAG_CAPTION : enable caption handler
- FORP_FLAG_ALIAS : enable alias handler
- FORP_FLAG_GROUPS : enable groups handler
- FORP_FLAG_HIGHLIGHT : enable HTML highlighting
forp_dump()
forp_dump() provides an array composed of :
- global fields : utime, stime ...
- stack : a flat PHP array of stack entries.
Global fields :
- utime : CPU used for user function calls
- stime : CPU used for system calls
Fields of a stack entry :
- file : file of the call
- lineno : line number of the call
- class : Class name
- function : function name
- groups : list of associated groups
- caption : caption of the function
- usec : function time (without the profiling overhead)
- pusec : inner profiling time (without executing the function)
- bytes : memory usage of the function
- level : depth level from the forp_start call
- parent : parent index (numeric)
forp_json()
Prints stack as JSON string directly on stdout. This is the fastest method in order to send the stack to a JSON compatible client.
See forp_dump() for its structure.
forp_json_google_tracer()
forp_json_google_tracer($filepath) will output stack as Google Trace Event format.
Usage :
Then, open Google Chrome or Chromium browser and go to chrome://tracing/. Load the output file and enjoy the result.
forp_inspect()
forp_inspect('symbol', $symbol) will output a detailed representation of a variable in the forp_dump() result.
Usage :
Result :
Available annotations
- @ProfileGroup
Sets groups that function belongs.
- @ProfileCaption
Adds caption to functions. Caption string may contain references (#) to parameters of the function.
- @ProfileAlias
Gives an alias name to a function. Useful for anonymous functions
- @ProfileHighlight
Adds a frame around output generated by the function.
Demos / UI
forp provides a structure so simple that it's easy to make your own UI.
But, if you are looking for a user interface with a lot of features, we've made a rich JavaScript client : forp-ui
You can see forp in action with the fastest PHP Frameworks :
- Beaba (https://github.com/ichiriac/beaba-light)
- Slim (https://github.com/codeguy/Slim)
- Silex (https://github.com/fabpot/Silex)
- Laravel (https://github.com/laravel/laravel)
Build status
Installation, requirements
Requirements
php5-dev
Install with Composer
Require forp-PHP-profiler in your project composer.json
run Composer install
compile
and enable forp in your php.ini
or opt for "old school" installation
Use current release
OR dev-master (unstable, at your own risk)
compile
and enable forp in your php.ini
Tested OS and platforms
Apache
Apache/2.2.16 (Debian)
PHP 5.3.8 (cli) (built: Sep 25 2012 22:55:18)
Nginx / php-fpm
nginx version: nginx/1.2.6
PHP 5.3.21-1~dotdeb.0 (fpm-fcgi) PHP 5.4.10-1~dotdeb.0 (fpm-fcgi)
Cloud / AWS
Centos 6.3 (AMI)
Apache/2.2.15 (Unix)
PHP 5.4.13 (cli) (built: Mar 15 2013 11:27:51)