MediaWiki  master
Profiler Class Reference

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

Inheritance diagram for Profiler:
Collaboration diagram for Profiler:

Public Member Functions

 __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...
 

Static Public Member Functions

static instance ()
 Singleton. More...
 
static replaceStubInstance (Profiler $profiler)
 Replace the current profiler with $profiler if no non-stub profiler is set. More...
 

Protected Attributes

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

 getOutputs ()
 Get all usable outputs. More...
 

Static Private Attributes

static Profiler $instance = null
 

Detailed Description

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

Definition at line 33 of file Profiler.php.

Constructor & Destructor Documentation

◆ __construct()

Profiler::__construct ( array  $params)
Parameters
array$params

Definition at line 50 of file Profiler.php.

References $params.

Member Function Documentation

◆ close()

Profiler::close ( )
abstract

Close opened profiling sections.

Referenced by getTransactionProfiler().

◆ getContentType()

Profiler::getContentType ( )

Get the content type sent out to the client.

Used for profilers that output instead of store data.

Returns
string
Since
1.25

Definition at line 272 of file Profiler.php.

References $header, as, and null.

◆ getContext()

Profiler::getContext ( )

Gets the context for this Profiler.

Returns
IContextSource
Since
1.25

Definition at line 140 of file Profiler.php.

References $context, RequestContext\getMain(), and wfDebug().

Referenced by logData().

◆ 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 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

Referenced by getTemplated(), logData(), and logDataPageOutputOnly().

◆ getOutput()

Profiler::getOutput ( )
abstract

Returns a profiling output to be stored in debug file.

Returns
string

Referenced by getTemplated().

◆ getOutputs()

Profiler::getOutputs ( )
private

Get all usable outputs.

Exceptions
MWException
Returns
ProfilerOutput[]
Since
1.25

Definition at line 195 of file Profiler.php.

References as.

Referenced by logData(), and logDataPageOutputOnly().

◆ getProfileID()

Profiler::getProfileID ( )
Returns
string

Definition at line 116 of file Profiler.php.

References $profileID, and WikiMap\getCurrentWikiDbDomain().

◆ getTemplated()

Profiler::getTemplated ( )

Was this call as templated or not.

Returns
bool

Definition at line 295 of file Profiler.php.

References $templated, getFunctionStats(), and getOutput().

◆ getTransactionProfiler()

Profiler::getTransactionProfiler ( )
Returns
TransactionProfiler
Since
1.25

Definition at line 179 of file Profiler.php.

References $trxProfiler, and close().

◆ instance()

◆ logData()

Profiler::logData ( )

Log the data to the backing store for all ProfilerOutput instances that have one.

Since
1.25

Definition at line 220 of file Profiler.php.

References $output, $request, as, getContext(), getFunctionStats(), and getOutputs().

◆ logDataPageOutputOnly()

Profiler::logDataPageOutputOnly ( )

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

Exceptions
MWException
Since
1.26

Definition at line 250 of file Profiler.php.

References $output, as, getFunctionStats(), and getOutputs().

◆ profileIn()

Profiler::profileIn (   $functionname)

Definition at line 150 of file Profiler.php.

References wfDeprecated().

◆ profileOut()

Profiler::profileOut (   $functionname)

Definition at line 154 of file Profiler.php.

References $section, scopedProfileIn(), and wfDeprecated().

◆ replaceStubInstance()

static Profiler::replaceStubInstance ( Profiler  $profiler)
staticfinal

Replace the current profiler with $profiler if no non-stub profiler is set.

Parameters
Profiler$profiler
Exceptions
MWException
Since
1.25

Definition at line 98 of file Profiler.php.

Referenced by Maintenance\activateProfiler().

◆ 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

Referenced by profileOut().

◆ scopedProfileOut()

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

Definition at line 171 of file Profiler.php.

References $section, and null.

◆ setContext()

Profiler::setContext (   $context)

Sets the context for this Profiler.

Parameters
IContextSource$context
Since
1.25

Definition at line 130 of file Profiler.php.

References $context.

◆ setProfileID()

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

Definition at line 109 of file Profiler.php.

◆ setTemplated()

Profiler::setTemplated (   $t)

Mark this call as templated or not.

Parameters
bool$t

Definition at line 286 of file Profiler.php.

References $t.

Member Data Documentation

◆ $context

IContextSource Profiler::$context = null
protected

Current request context.

Definition at line 41 of file Profiler.php.

Referenced by getContext(), and setContext().

◆ $instance

Profiler Profiler::$instance = null
staticprivate

Definition at line 45 of file Profiler.php.

◆ $params

array Profiler::$params = []
protected

All of the params passed from $wgProfiler.

Definition at line 39 of file Profiler.php.

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

◆ $profileID

string bool Profiler::$profileID = false
protected

Profiler ID for bucketing data.

Definition at line 35 of file Profiler.php.

Referenced by getProfileID().

◆ $templated

bool Profiler::$templated = false
protected

Whether MediaWiki is in a SkinTemplate output context.

Definition at line 37 of file Profiler.php.

Referenced by getTemplated().

◆ $trxProfiler

TransactionProfiler Profiler::$trxProfiler
protected

Definition at line 43 of file Profiler.php.

Referenced by getTransactionProfiler().


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