MediaWiki  master
ProfilerXhprof Class Reference

Profiler wrapper for XHProf extension. More...

Inheritance diagram for ProfilerXhprof:
Collaboration diagram for ProfilerXhprof:

Public Member Functions

 __construct (array $params=[])
 
 close ()
 No-op for xhprof profiling. More...
 
 getFunctionStats ()
 
 getOutput ()
 Returns a profiling output to be stored in debug file. More...
 
 getRawData ()
 Retrieve raw data from xhprof. More...
 
 getXhprofData ()
 
 scopedProfileIn ( $section)
 
- Public Member Functions inherited from Profiler
 __construct (array $params)
 
 close ()
 Close opened profiling sections. More...
 
 getContentType ()
 Get the content type sent out to the client. More...
 
 getContext ()
 Gets the context for this Profiler. More...
 
 getFunctionStats ()
 Get the aggregated inclusive profiling data for each method. More...
 
 getOutput ()
 Returns a profiling output to be stored in debug file. More...
 
 getProfileID ()
 
 getTemplated ()
 Was this call as templated or not. More...
 
 getTransactionProfiler ()
 
 logData ()
 Log the data to the backing store for all ProfilerOutput instances that have one. More...
 
 logDataPageOutputOnly ()
 Log the data to the script/request output for all ProfilerOutput instances that do so. More...
 
 profileIn ( $functionname)
 
 profileOut ( $functionname)
 
 scopedProfileIn ( $section)
 Mark the start of a custom profiling frame (e.g. More...
 
 scopedProfileOut (SectionProfileCallback &$section=null)
 
 setContext ( $context)
 Sets the context for this Profiler. More...
 
 setProfileID ( $id)
 
 setTemplated ( $t)
 Mark this call as templated or not. More...
 

Protected Member Functions

 getFunctionReport ()
 Get a report of profiled functions sorted by inclusive wall clock time in descending order. More...
 

Protected Attributes

SectionProfiler $sprofiler
 Profiler for explicit, arbitrary, frame labels. More...
 
 $xhprofData
 
- Protected Attributes inherited from Profiler
IContextSource $context = null
 Current request context. More...
 
array $params = []
 All of the params passed from $wgProfiler. More...
 
string bool $profileID = false
 Profiler ID for bucketing data. More...
 
bool $templated = false
 Whether MediaWiki is in a SkinTemplate output context. More...
 
TransactionProfiler $trxProfiler
 

Private Member Functions

 shouldExclude ( $name)
 Check if a function or section should be excluded from the output. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Profiler
static instance ()
 Singleton. More...
 
static replaceStubInstance (Profiler $profiler)
 Replace the current profiler with $profiler if no non-stub profiler is set. More...
 

Detailed Description

Profiler wrapper for XHProf extension.

$wgProfiler['flags'] = XHPROF_FLAGS_NO_BUILTINS;
$wgProfiler['output'] = 'text';
$wgProfiler['visible'] = true;
$wgProfiler['flags'] = XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY | XHPROF_FLAGS_NO_BUILTINS;
$wgProfiler['output'] = 'udp';

ProfilerXhprof profiles all functions using the XHProf PHP extenstion. For PHP5 users, this extension can be installed via PECL or your operating system's package manager. XHProf support is built into HHVM.

To restrict the functions for which profiling data is collected, you can use either a whitelist ($wgProfiler['include']) or a blacklist ($wgProfiler['exclude']) containing an array of function names. Shell-style patterns are also accepted.

This also supports Tideways-XHProf PHP extension, which is mostly a drop-in replacement for Xhprof (replace XHPROF_FLAGS_* with XHPROF_TIDEWAYS_FLAGS_*), as well as the older (discontinued) Tideways extension (TIDEWAYS_FLAGS_*).

Note
© 2014 Wikimedia Foundation and contributors
See also
Xhprof
https://php.net/xhprof
https://github.com/facebook/hhvm/blob/master/hphp/doc/profiling.md
https://github.com/tideways/php-xhprof-extension

Definition at line 57 of file ProfilerXhprof.php.

Constructor & Destructor Documentation

◆ __construct()

ProfilerXhprof::__construct ( array  $params = [])
Parameters
array$params
See also
Xhprof::__construct()

Definition at line 73 of file ProfilerXhprof.php.

References $options, Profiler\$params, and Xhprof\enable().

Member Function Documentation

◆ close()

ProfilerXhprof::close ( )

No-op for xhprof profiling.

Definition at line 101 of file ProfilerXhprof.php.

◆ getFunctionReport()

ProfilerXhprof::getFunctionReport ( )
protected

Get a report of profiled functions sorted by inclusive wall clock time in descending order.

Each line of the report includes this data:

  • Function name
  • Number of times function was called
  • Total wall clock time spent in function in microseconds
  • Minimum wall clock time spent in function in microseconds
  • Average wall clock time spent in function in microseconds
  • Maximum wall clock time spent in function in microseconds
  • Percentage of total wall clock time spent in function
  • Total delta of memory usage from start to end of function in bytes
Returns
string

Definition at line 201 of file ProfilerXhprof.php.

References $out, as, and getFunctionStats().

Referenced by getOutput().

◆ getFunctionStats()

ProfilerXhprof::getFunctionStats ( )

Definition at line 132 of file ProfilerXhprof.php.

References $fname, as, getXhprofData(), null, and shouldExclude().

Referenced by getFunctionReport().

◆ getOutput()

ProfilerXhprof::getOutput ( )

Returns a profiling output to be stored in debug file.

Returns
string

Definition at line 181 of file ProfilerXhprof.php.

References getFunctionReport().

◆ getRawData()

ProfilerXhprof::getRawData ( )

Retrieve raw data from xhprof.

Returns
array

Definition at line 233 of file ProfilerXhprof.php.

References getXhprofData().

◆ getXhprofData()

ProfilerXhprof::getXhprofData ( )
Returns
XhprofData

Definition at line 86 of file ProfilerXhprof.php.

References $xhprofData, and Xhprof\disable().

Referenced by getFunctionStats(), and getRawData().

◆ scopedProfileIn()

ProfilerXhprof::scopedProfileIn (   $section)

Definition at line 93 of file ProfilerXhprof.php.

References $section.

◆ shouldExclude()

ProfilerXhprof::shouldExclude (   $name)
private

Check if a function or section should be excluded from the output.

Parameters
string$nameFunction or section name.
Returns
bool

Definition at line 110 of file ProfilerXhprof.php.

References $name, and as.

Referenced by getFunctionStats().

Member Data Documentation

◆ $sprofiler

SectionProfiler ProfilerXhprof::$sprofiler
protected

Profiler for explicit, arbitrary, frame labels.

Definition at line 67 of file ProfilerXhprof.php.

◆ $xhprofData

XhprofData null ProfilerXhprof::$xhprofData
protected

Definition at line 61 of file ProfilerXhprof.php.

Referenced by getXhprofData().


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