MediaWiki  1.23.1
ProfilerSimple Class Reference

Simple profiler base class. More...

Inheritance diagram for ProfilerSimple:
Collaboration diagram for ProfilerSimple:

Public Member Functions

 getErrorEntry ()
 
 getFunctionReport ()
 Returns a list of profiled functions. More...
 
 getRawData ()
 
 getZeroEntry ()
 
 isPersistent ()
 Return whether this profiler stores data. More...
 
 logData ()
 Log the whole profiling data into the database. More...
 
 profileIn ( $functionname)
 Called by wfProfieIn() More...
 
 profileOut ( $functionname)
 Called by wfProfieOut() More...
 
 setMinimum ( $min)
 
 updateEntry ( $name, $elapsedCpu, $elapsedReal)
 
- Public Member Functions inherited from Profiler
 __construct ( $params)
 
 calltreeCount ( $stack, $start)
 Counts the number of profiled function calls sitting under the given point in the call graph. More...
 
 close ()
 Close opened profiling sections. More...
 
 debug ( $s)
 Add an entry in the debug log file. More...
 
 debugGroup ( $group, $s)
 Add an entry in the debug log group. More...
 
 getCallTree ()
 Returns a tree of function call instead of a list of functions. More...
 
 getCallTreeLine ( $entry)
 Callback to get a formatted line for the call tree. More...
 
 getCurrentSection ()
 Get the function name of the current profiling section. More...
 
 getOutput ()
 Returns a profiling output to be stored in debug file. More...
 
 getProfileID ()
 
 getTime ( $metric=false)
 Get the initial time of the request, based either on $wgRequestTime or $wgRUstart. More...
 
 isStub ()
 Return whether this a stub profiler. More...
 
 remapCallTree ( $stack)
 Recursive function the format the current profiling array into a tree. More...
 
 setProfileID ( $id)
 
 setTemplated ( $t)
 Mark this call as templated or not. More...
 
 transactionWritingIn ( $server, $db)
 Mark a DB as in a transaction with one or more writes pending. More...
 
 transactionWritingOut ( $server, $db)
 Mark a DB as no longer in a transaction. More...
 

Public Attributes

 $errorEntry
 
 $mMinimumTime = 0
 
- Public Attributes inherited from Profiler
 $mCalls = array()
 
 $mCollated = array()
 
 $mCollateDone = false
 
 $mPeriods = array()
 
 $mTemplated = false
 
 $mTotals = array()
 
 $mWorkStack = array()
 

Protected Member Functions

 addInitialStack ()
 Add the inital item in the stack. More...
 
- Protected Member Functions inherited from Profiler
 collateData ()
 
 getContentType ()
 Get the content type sent out to the client. More...
 
 getInitialTime ( $metric=false)
 Get the initial time of the request, based either on $wgRequestTime or $wgRUstart. More...
 
 updateTrxProfiling ( $method, $realtime)
 Register the name and time of a method for slow DB trx detection. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Profiler
static instance ()
 Singleton. More...
 
static setInstance (Profiler $p)
 Set the profiler to a specific profiler instance. More...
 
- Static Public Attributes inherited from Profiler
static $__instance = null
 
- Static Protected Member Functions inherited from Profiler
static calculateOverhead ( $profileCount)
 Dummy calls to wfProfileIn/wfProfileOut to calculate its overhead. More...
 
- Protected Attributes inherited from Profiler
 $mDBLockThreshold = 5.0
 
 $mDBTrxHoldingLocks = array()
 
 $mDBTrxMethodTimes = array()
 
 $mProfileID = false
 
 $mStack = array()
 
 $mTimeMetric = 'wall'
 

Detailed Description

Simple profiler base class.

Todo:
document methods (?)

Definition at line 29 of file ProfilerSimple.php.

Member Function Documentation

◆ addInitialStack()

ProfilerSimple::addInitialStack ( )
protected

Add the inital item in the stack.

Reimplemented from Profiler.

Definition at line 68 of file ProfilerSimple.php.

References array(), getErrorEntry(), Profiler\getInitialTime(), profileIn(), and profileOut().

◆ getErrorEntry()

ProfilerSimple::getErrorEntry ( )

Definition at line 44 of file ProfilerSimple.php.

References getZeroEntry().

Referenced by addInitialStack().

◆ getFunctionReport()

ProfilerSimple::getFunctionReport ( )

Returns a list of profiled functions.

Returns
string

Reimplemented from Profiler.

Definition at line 132 of file ProfilerSimple.php.

◆ getRawData()

ProfilerSimple::getRawData ( )
Returns
array

Reimplemented from Profiler.

Definition at line 126 of file ProfilerSimple.php.

References array().

◆ getZeroEntry()

ProfilerSimple::getZeroEntry ( )

Definition at line 34 of file ProfilerSimple.php.

References array().

Referenced by getErrorEntry(), and updateEntry().

◆ isPersistent()

ProfilerSimple::isPersistent ( )

Return whether this profiler stores data.

See also
Profiler::logData()
Returns
Boolean

Reimplemented from Profiler.

Reimplemented in ProfilerSimpleUDP.

Definition at line 63 of file ProfilerSimple.php.

◆ logData()

ProfilerSimple::logData ( )

Log the whole profiling data into the database.

Reimplemented from Profiler.

Reimplemented in ProfilerSimpleTrace, ProfilerSimpleText, and ProfilerSimpleUDP.

Definition at line 137 of file ProfilerSimple.php.

◆ profileIn()

ProfilerSimple::profileIn (   $functionname)

Called by wfProfieIn()

Parameters
$functionnameString

Reimplemented from Profiler.

Reimplemented in ProfilerSimpleTrace.

Definition at line 87 of file ProfilerSimple.php.

References array(), Profiler\debug(), Profiler\getTime(), and global.

Referenced by addInitialStack().

◆ profileOut()

ProfilerSimple::profileOut (   $functionname)

Called by wfProfieOut()

Parameters
$functionnameString

Reimplemented from Profiler.

Reimplemented in ProfilerSimpleTrace.

Definition at line 95 of file ProfilerSimple.php.

References $errorEntry, Profiler\debug(), Profiler\debugGroup(), Profiler\getTime(), global, list, updateEntry(), and Profiler\updateTrxProfiling().

Referenced by addInitialStack().

◆ setMinimum()

ProfilerSimple::setMinimum (   $min)

Definition at line 83 of file ProfilerSimple.php.

◆ updateEntry()

ProfilerSimple::updateEntry (   $name,
  $elapsedCpu,
  $elapsedReal 
)

Definition at line 50 of file ProfilerSimple.php.

References $name, and getZeroEntry().

Referenced by profileOut().

Member Data Documentation

◆ $errorEntry

ProfilerSimple::$errorEntry

Definition at line 32 of file ProfilerSimple.php.

Referenced by profileOut().

◆ $mMinimumTime

ProfilerSimple::$mMinimumTime = 0

Definition at line 30 of file ProfilerSimple.php.


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