BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
XhprofData Class Reference

Public Member Functions

 __construct (array $data, array $config=[])
 
 getRawData ()
 
 getInclusiveMetrics ()
 
 getCompleteMetrics ()
 
 getCallers ($function)
 
 getCallees ($function)
 
 getCriticalPath ($metric= 'wt')
 

Static Public Member Functions

static splitKey ($key)
 
static makeSortFunction ($key, $sub)
 

Protected Member Functions

 pruneData ($data)
 

Protected Attributes

 $config
 
 $hieraData
 
 $inclusive
 
 $complete
 

Detailed Description

Convenience class for working with XHProf profiling data https://github.com/phacility/xhprof. XHProf can be installed as a PECL package for use with PHP5 (Zend PHP) and is built-in to HHVM 3.3.0.

Since
1.28

Constructor & Destructor Documentation

XhprofData::__construct ( array  $data,
array  $config = [] 
)

Configuration data can contain:

  • include: Array of function names to include in profiling.
  • sort: Key to sort per-function reports on.
Parameters
array$dataXhprof profiling data, as returned by xhprof_disable()
array$config

Member Function Documentation

XhprofData::getCallees (   $function)

Get a list of all callees from a given function.

Parameters
string$functionFunction name
Returns
array
See Also
getEdges()
XhprofData::getCallers (   $function)

Get a list of all callers of a given function.

Parameters
string$functionFunction name
Returns
array
See Also
getEdges()
XhprofData::getCompleteMetrics ( )

Get the inclusive and exclusive metrics for each function call.

In addition to the normal data contained in the inclusive metrics, the metrics have an additional 'exclusive' measurement which is the total minus the totals of all child function calls.

Returns
array
See Also
getRawData()
getInclusiveMetrics()
XhprofData::getCriticalPath (   $metric = 'wt')

Find the critical path for the given metric.

Parameters
string$metricMetric to find critical path for
Returns
array
XhprofData::getInclusiveMetrics ( )

Get the inclusive metrics for each function call. Inclusive metrics for given function include the metrics for all functions that were called from that function during the measurement period.

See getRawData() for a description of the metric that are returned for each funcition call. The values for the wt, cpu, mu and pmu metrics are arrays with these values:

  • total: Cumulative value
  • min: Minimum value
  • mean: Mean (average) value
  • max: Maximum value
  • variance: Variance (spread) of the values
Returns
array
See Also
getRawData()
getCompleteMetrics()
XhprofData::getRawData ( )

Get raw data collected by xhprof.

Each key in the returned array is an edge label for the call graph in the form "caller==>callee". There is once special case edge labled simply "main()" which represents the global scope entry point of the application.

XHProf will collect different data depending on the flags that are used:

  • ct: Number of matching events seen.
  • wt: Inclusive elapsed wall time for this event in microseconds.
  • cpu: Inclusive elapsed cpu time for this event in microseconds. (XHPROF_FLAGS_CPU)
  • mu: Delta of memory usage from start to end of callee in bytes. (XHPROF_FLAGS_MEMORY)
  • pmu: Delta of peak memory usage from start to end of callee in bytes. (XHPROF_FLAGS_MEMORY)
  • alloc: Delta of amount memory requested from malloc() by the callee, in bytes. (XHPROF_FLAGS_MALLOC)
  • free: Delta of amount of memory passed to free() by the callee, in bytes. (XHPROF_FLAGS_MALLOC)
Returns
array
See Also
getInclusiveMetrics()
getCompleteMetrics()
static XhprofData::makeSortFunction (   $key,
  $sub 
)
static

Make a closure to use as a sort function. The resulting function will sort by descending numeric values (largest value first).

Parameters
string$keyData key to sort on
string$subSub key to sort array values on
Returns
Closure
XhprofData::pruneData (   $data)
protected

Remove data for functions that are not included in the 'include' configuration array.

Parameters
array$dataRaw xhprof data
Returns
array
static XhprofData::splitKey (   $key)
static

Convert an xhprof data key into an array of ['parent', 'child'] function names.

The resulting array is left padded with nulls, so a key with no parent (eg 'main()') will return [null, 'function'].

Parameters
string$key
Returns
array

Member Data Documentation

array XhprofData::$complete
protected

Per-function inclusive and exclusive data.

array XhprofData::$hieraData
protected

Hierarchical profiling data returned by xhprof.

array XhprofData::$inclusive
protected

Per-function inclusive data.


The documentation for this class was generated from the following file: