MediaWiki  master
Profiler Class Reference

Profiler base class that defines the interface and some shared functionality. More...

Inheritance diagram for Profiler:
Collaboration diagram for Profiler:

Public Member Functions

 __construct (array $params)
 
 close ()
 Close opened profiling sections. More...
 
 getAllowOutput ()
 Whether appending profiles is allowed. More...
 
 getContentType ()
 Get the Content-Type for deciding how to format appended profile output. More...
 
 getContext ()
 
 getFunctionStats ()
 Get the aggregated inclusive profiling data for each method. More...
 
 getOutput ()
 Returns a profiling output to be stored in debug file. More...
 
 getProfileID ()
 
 getTransactionProfiler ()
 
 logData ()
 Log data to all the applicable backing stores. More...
 
 logDataPageOutputOnly ()
 Log the data to the script/request output for all ProfilerOutput instances that do so. More...
 
 scopedProfileIn ( $section)
 Mark the start of a custom profiling frame (e.g. More...
 
 scopedProfileOut (SectionProfileCallback &$section=null)
 
 setAllowOutput ()
 Enable appending profiles to standard output. More...
 
 setContext ( $context)
 
 setProfileID ( $id)
 

Static Public Member Functions

static init (array $profilerConf)
 
static instance ()
 Singleton. More...
 

Protected Attributes

IContextSource $context = null
 Current request context. More...
 
LoggerInterface $logger
 
array $params = []
 All of the params passed from $wgProfiler. More...
 
string false $profileID = false
 Profiler ID for bucketing data. More...
 
TransactionProfiler $trxProfiler
 

Detailed Description

Profiler base class that defines the interface and some shared functionality.

Definition at line 36 of file Profiler.php.

Constructor & Destructor Documentation

◆ __construct()

Profiler::__construct ( array  $params)
Parameters
array$paramsSee $wgProfiler.

Reimplemented in ProfilerXhprof, ProfilerSectionOnly, and ProfilerExcimer.

Definition at line 56 of file Profiler.php.

References $params.

Member Function Documentation

◆ close()

Profiler::close ( )
abstract

Close opened profiling sections.

Reimplemented in ProfilerXhprof, ProfilerStub, ProfilerSectionOnly, and ProfilerExcimer.

◆ getAllowOutput()

Profiler::getAllowOutput ( )

Whether appending profiles is allowed.

Since
1.34
Returns
bool

Definition at line 304 of file Profiler.php.

◆ getContentType()

Profiler::getContentType ( )

Get the Content-Type for deciding how to format appended profile output.

Disabled by default. Enable via setAllowOutput().

See also
ProfilerOutputText
Since
1.25
Returns
string|null Returns null if disabled or no Content-Type found.

Definition at line 278 of file Profiler.php.

References $header.

◆ getContext()

Profiler::getContext ( )
Access: internal
Returns
IContextSource
Since
1.25

Definition at line 149 of file Profiler.php.

References RequestContext\getMain(), and wfDeprecated().

◆ getFunctionStats()

Profiler::getFunctionStats ( )
abstract

Get the aggregated inclusive profiling data for each method.

The percent time for each time is based on the current "total" time used is based on all methods so far. This method can therefore be called several times in between several profiling calls without the delays in usage of the profiler skewing the results. A "-total" entry is always included in the results.

When a call chain involves a method invoked within itself, any entries for the cyclic invocation should be demarked with "@". This makes filtering them out easier and follows the xhprof style.

Returns
array[] List of method entries arrays, each having:
  • name : method name
  • calls : the number of invoking calls
  • real : real time elapsed (ms)
  • real : percent real time
  • cpu : CPU time elapsed (ms)
  • cpu : percent CPU time
  • memory : memory used (bytes)
  • memory : percent memory used
  • min_real : min real time in a call (ms)
  • max_real : max real time in a call (ms)
Since
1.25

Reimplemented in ProfilerXhprof, ProfilerStub, ProfilerSectionOnly, and ProfilerExcimer.

◆ getOutput()

Profiler::getOutput ( )
abstract

Returns a profiling output to be stored in debug file.

Returns
string

Reimplemented in ProfilerXhprof, ProfilerStub, ProfilerSectionOnly, and ProfilerExcimer.

◆ getProfileID()

Profiler::getProfileID ( )
Returns
string

Definition at line 126 of file Profiler.php.

References WikiMap\getCurrentWikiDbDomain().

◆ getTransactionProfiler()

Profiler::getTransactionProfiler ( )
Returns
TransactionProfiler
Since
1.25

Definition at line 175 of file Profiler.php.

◆ init()

static Profiler::init ( array  $profilerConf)
staticfinal
Access: internal
For use by Setup.php
Parameters
array$profilerConfValue from $wgProfiler

Definition at line 69 of file Profiler.php.

References $params.

◆ instance()

◆ logData()

Profiler::logData ( )

Log data to all the applicable backing stores.

This logs the profiling data to the backing store for each configured ProfilerOutput instance. It also logs any request data for the TransactionProfiler instance.

Since
1.25

Reimplemented in ProfilerStub.

Definition at line 219 of file Profiler.php.

◆ logDataPageOutputOnly()

Profiler::logDataPageOutputOnly ( )

Log the data to the script/request output for all ProfilerOutput instances that do so.

Exceptions
MWException
Since
1.26

Reimplemented in ProfilerStub.

Definition at line 249 of file Profiler.php.

◆ scopedProfileIn()

Profiler::scopedProfileIn (   $section)
abstract

Mark the start of a custom profiling frame (e.g.

DB queries). The frame ends when the result of this method falls out of scope.

Parameters
string$section
Returns
ScopedCallback|null
Since
1.25

Reimplemented in ProfilerXhprof, ProfilerStub, ProfilerSectionOnly, and ProfilerExcimer.

◆ scopedProfileOut()

Profiler::scopedProfileOut ( SectionProfileCallback $section = null)
Parameters
SectionProfileCallback | null&$section

Definition at line 167 of file Profiler.php.

◆ setAllowOutput()

Profiler::setAllowOutput ( )

Enable appending profiles to standard output.

Since
1.34

Definition at line 294 of file Profiler.php.

◆ setContext()

Profiler::setContext (   $context)
Access: internal
Parameters
IContextSource$context
Since
1.25

Definition at line 139 of file Profiler.php.

References wfDeprecated().

◆ setProfileID()

Profiler::setProfileID (   $id)
Parameters
string$id

Definition at line 119 of file Profiler.php.

Member Data Documentation

◆ $context

IContextSource Profiler::$context = null
protected

Current request context.

Definition at line 42 of file Profiler.php.

◆ $logger

LoggerInterface Profiler::$logger
protected

Definition at line 46 of file Profiler.php.

◆ $params

array Profiler::$params = []
protected

All of the params passed from $wgProfiler.

Definition at line 40 of file Profiler.php.

Referenced by __construct(), ProfilerExcimer\__construct(), ProfilerSectionOnly\__construct(), ProfilerXhprof\__construct(), and init().

◆ $profileID

string false Profiler::$profileID = false
protected

Profiler ID for bucketing data.

Definition at line 38 of file Profiler.php.

◆ $trxProfiler

TransactionProfiler Profiler::$trxProfiler
protected

Definition at line 44 of file Profiler.php.


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