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

Inherited by ProfilerExcimer, ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

Collaboration diagram for Profiler:

[legend]

Public Member Functions
	__construct (array $params)

	close ()
	Close opened profiling sections.

	getAllowOutput ()
	Whether appending profiles is allowed.

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

	getFunctionStats ()
	Get the aggregated inclusive profiling data for each method.

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

	getProfileID ()

	getTransactionProfiler ()

	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.

	scopedProfileOut (SectionProfileCallback &$section=null)

	setAllowOutput ()
	Enable appending profiles to standard output.

	setProfileID ( $id)

Static Public Member Functions
static	init (array $profilerConf)

static	instance ()

Protected Attributes
LoggerInterface	$logger

array	$params = []
	All of the params passed from $wgProfiler.

string false	$profileID = false
	Profiler ID for bucketing data.

TransactionProfiler	$trxProfiler

Detailed Description

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

Definition at line 37 of file Profiler.php.

Constructor & Destructor Documentation

◆ __construct()

Profiler::__construct ( array $params )

Parameters

array $params See $wgProfiler.

Reimplemented in ProfilerExcimer, ProfilerSectionOnly, and ProfilerXhprof.

Definition at line 55 of file Profiler.php.

References $params.

Member Function Documentation

◆ close()

Profiler::close ( )

abstract

Close opened profiling sections.

Reimplemented in ProfilerExcimer, ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

◆ getAllowOutput()

Profiler::getAllowOutput ( )

Whether appending profiles is allowed.

Deprecated:: since 1.41. Unused.

Since: 1.34

Returns: bool

Definition at line 286 of file Profiler.php.

References wfDeprecated().

◆ 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 258 of file Profiler.php.

References $header.

◆ 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 ProfilerExcimer, ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

◆ getOutput()

Profiler::getOutput ( )

abstract

Returns a profiling output to be stored in debug file.

Returns: string

Reimplemented in ProfilerExcimer, ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

◆ getProfileID()

Profiler::getProfileID ( )

Returns: string

Definition at line 126 of file Profiler.php.

◆ getTransactionProfiler()

Profiler::getTransactionProfiler ( )

Returns: TransactionProfiler

Since: 1.25

Definition at line 155 of file Profiler.php.

◆ init()

static Profiler::init ( array $profilerConf )

staticfinal

Access: internal: For use by Setup.php

Parameters

array $profilerConf Value from $wgProfiler

Definition at line 68 of file Profiler.php.

References $params.

◆ instance()

static Profiler::instance ( )

staticfinal

Returns: Profiler

Definition at line 105 of file Profiler.php.

Referenced by MWLBFactory\applyDefaultConfig(), FileBackendGroup\config(), MediaWiki\Http\HttpRequestFactory\create(), MediaWiki\Specials\SpecialConfirmEmail\execute(), MediaWiki\Specials\SpecialEmailInvalidate\execute(), ApiRollback\execute(), MediaWiki\SpecialPage\SpecialPageFactory\executePath(), LCStoreDB\finishWrite(), SkinTemplate\outputPage(), MediaWiki\restInPeace(), ApiMain\setRequestExpectations(), and wfLoadMain().

◆ 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 199 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 229 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 ProfilerExcimer, ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

◆ scopedProfileOut()

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

Parameters

SectionProfileCallback | null &$section

Definition at line 147 of file Profiler.php.

◆ setAllowOutput()

Profiler::setAllowOutput ( )

Enable appending profiles to standard output.

Since: 1.34

Definition at line 274 of file Profiler.php.

◆ setProfileID()

Profiler::setProfileID ( $id )

Deprecated:: since 1.41, unused. Can override this base class.

Parameters

string $id

Definition at line 118 of file Profiler.php.

References wfDeprecated().

Member Data Documentation

◆ $logger

LoggerInterface Profiler::$logger

protected

Definition at line 45 of file Profiler.php.

◆ $params

array Profiler::$params = []

protected

All of the params passed from $wgProfiler.

Definition at line 41 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 39 of file Profiler.php.

◆ $trxProfiler

TransactionProfiler Profiler::$trxProfiler

protected

Definition at line 43 of file Profiler.php.

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

includes/profiler/Profiler.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ close()

◆ getAllowOutput()

◆ getContentType()

◆ getFunctionStats()

◆ getOutput()

◆ getProfileID()

◆ getTransactionProfiler()

◆ init()

◆ instance()

◆ logData()

◆ logDataPageOutputOnly()

◆ scopedProfileIn()

◆ scopedProfileOut()

◆ setAllowOutput()

◆ setProfileID()

Member Data Documentation

◆ $logger

◆ $params

◆ $profileID

◆ $trxProfiler