MediaWiki master
Public Member Functions | List of all members
MediaWiki\Profiler\ProfilerStub Class Reference
Profiler

Stub profiler that does nothing. More...

Inherits MediaWiki\Profiler\Profiler.

Collaboration diagram for MediaWiki\Profiler\ProfilerStub:
Collaboration graph
[legend]

Public Member Functions

 close ()
 Close opened profiling sections.
 
 getFunctionStats ()
 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

 
 getOutput ()
 Returns a profiling output to be stored in debug file.
Returns
string

 
 logData ()
 Log data to all the applicable backing stores.
 
 logDataPageOutputOnly ()
 Log the data to the script/request output for all ProfilerOutput instances that do so.
 
 scopedProfileIn ( $section)
 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
Since
1.25

 
- Public Member Functions inherited from MediaWiki\Profiler\Profiler
 __construct (array $params)
 
 getContentType ()
 Get the Content-Type for deciding how to format appended profile output.
 
 getProfileID ()
 
 getTransactionProfiler ()
 
 scopedProfileOut (?SectionProfileCallback &$section=null)
 
 setAllowOutput ()
 Enable appending profiles to standard output.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\Profiler\Profiler
static init (array $profilerConf)
 
static instance ()
 
- Protected Attributes inherited from MediaWiki\Profiler\Profiler
LoggerInterface $logger
 
array $params = []
 All of the params passed from $wgProfiler.
 
string false $profileID = false
 Profiler ID for bucketing data.
 
TransactionProfiler $trxProfiler
 

Detailed Description

Stub profiler that does nothing.

Definition at line 14 of file ProfilerStub.php.

Member Function Documentation

◆ close()

MediaWiki\Profiler\ProfilerStub::close ( )

Close opened profiling sections.

Reimplemented from MediaWiki\Profiler\Profiler.

Definition at line 31 of file ProfilerStub.php.

◆ getFunctionStats()

MediaWiki\Profiler\ProfilerStub::getFunctionStats ( )

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 from MediaWiki\Profiler\Profiler.

Definition at line 22 of file ProfilerStub.php.

◆ getOutput()

MediaWiki\Profiler\ProfilerStub::getOutput ( )

Returns a profiling output to be stored in debug file.

Returns
string

Reimplemented from MediaWiki\Profiler\Profiler.

Definition at line 27 of file ProfilerStub.php.

◆ logData()

MediaWiki\Profiler\ProfilerStub::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 from MediaWiki\Profiler\Profiler.

Definition at line 34 of file ProfilerStub.php.

◆ logDataPageOutputOnly()

MediaWiki\Profiler\ProfilerStub::logDataPageOutputOnly ( )

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

Since
1.26

Reimplemented from MediaWiki\Profiler\Profiler.

Definition at line 37 of file ProfilerStub.php.

◆ scopedProfileIn()

MediaWiki\Profiler\ProfilerStub::scopedProfileIn ( $section)

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
Since
1.25

Reimplemented from MediaWiki\Profiler\Profiler.

Definition at line 17 of file ProfilerStub.php.

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