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

Inheritance diagram for Profiler:

[legend]

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.

	getContext ()
	Gets the context for this Profiler.

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

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

	getProfileID ()

	getTemplated ()
	Was this call as templated or not.

	getTransactionProfiler ()

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

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

	profileIn ( $functionname)

	profileOut ( $functionname)

	scopedProfileIn ( $section)
	Mark the start of a custom profiling frame (e.g.

	scopedProfileOut (SectionProfileCallback &$section=null)

	setAllowOutput ()
	Enable appending profiles to standard output.

	setContext ( $context)
	Sets the context for this Profiler.

	setProfileID ( $id)

	setTemplated ( $t)
	Mark this call as templated or not.

Static Public Member Functions
static	instance ()
	Singleton.

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

Protected Attributes
IContextSource	$context = null
	Current request context.

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

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

TransactionProfiler	$trxProfiler

Private Member Functions
	getOutputs ()
	Get all usable outputs.

Private Attributes
bool	$allowOutput = false

Static Private Attributes
static Profiler	$instance = null

Detailed Description

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

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

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.

Since: 1.34

Returns: bool

Definition at line 325 of file Profiler.php.

Referenced by getTemplated().

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

References $header.

◆ getContext()

Profiler::getContext ( )

Gets the context for this Profiler.

Returns: IContextSource

Since: 1.25

Definition at line 138 of file Profiler.php.

References wfDebug().

◆ 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

Reimplemented in ProfilerExcimer, ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

Referenced by logData(), and logDataPageOutputOnly().

◆ getOutput()

Profiler::getOutput ( )

abstract

Returns a profiling output to be stored in debug file.

Returns: string

Reimplemented in ProfilerExcimer, ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

◆ getOutputs()

Profiler::getOutputs ( )

private

Get all usable outputs.

Exceptions

MWException

Returns: ProfilerOutput[]

Since: 1.25

Definition at line 193 of file Profiler.php.

Referenced by logData(), and logDataPageOutputOnly().

◆ getProfileID()

Profiler::getProfileID ( )

Returns: string

Definition at line 114 of file Profiler.php.

◆ getTemplated()

Profiler::getTemplated ( )

Was this call as templated or not.

Deprecated: since 1.34 Use getAllowOutput() instead.

Returns: bool

Definition at line 305 of file Profiler.php.

References getAllowOutput(), and wfDeprecated().

◆ getTransactionProfiler()

Profiler::getTransactionProfiler ( )

Returns: TransactionProfiler

Since: 1.25

Definition at line 177 of file Profiler.php.

◆ instance()

static Profiler::instance ( )

staticfinal

Singleton.

Returns: Profiler

Definition at line 63 of file Profiler.php.

References $wgProfiler.

Referenced by MediaWiki\Http\HttpRequestFactory\create().

◆ logData()

Profiler::logData ( )

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

Since: 1.25

Reimplemented in ProfilerStub.

Definition at line 218 of file Profiler.php.

References 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

Reimplemented in ProfilerStub.

Definition at line 248 of file Profiler.php.

References getFunctionStats(), and getOutputs().

◆ profileIn()

Profiler::profileIn ( $functionname )

Definition at line 148 of file Profiler.php.

References wfDeprecated().

◆ profileOut()

Profiler::profileOut ( $functionname )

Definition at line 152 of file Profiler.php.

References 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 96 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 169 of file Profiler.php.

◆ setAllowOutput()

Profiler::setAllowOutput ( )

Enable appending profiles to standard output.

Since: 1.34

Definition at line 315 of file Profiler.php.

◆ setContext()

Profiler::setContext ( $context )

Sets the context for this Profiler.

Parameters

IContextSource $context

Since: 1.25

Definition at line 128 of file Profiler.php.

◆ setProfileID()

Profiler::setProfileID ( $id )

Parameters

string $id

Definition at line 107 of file Profiler.php.

◆ setTemplated()

Profiler::setTemplated ( $t )

Mark this call as templated or not.

Deprecated: since 1.34 Use setAllowOutput() instead.

Parameters

bool $t

Definition at line 294 of file Profiler.php.

References $t, true, and wfDeprecated().

Member Data Documentation

◆ $allowOutput

bool Profiler::$allowOutput = false

private

Definition at line 43 of file Profiler.php.

◆ $context

IContextSource Profiler::$context = null

protected

Current request context.

Definition at line 39 of file Profiler.php.

◆ $instance

Profiler Profiler::$instance = null

staticprivate

Definition at line 46 of file Profiler.php.

◆ $params

array Profiler::$params = []

protected

All of the params passed from $wgProfiler.

Definition at line 37 of file Profiler.php.

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

◆ $profileID

string bool Profiler::$profileID = false

protected

Profiler ID for bucketing data.

Definition at line 35 of file Profiler.php.

◆ $trxProfiler

TransactionProfiler Profiler::$trxProfiler

protected

Definition at line 41 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

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ close()

◆ getAllowOutput()

◆ getContentType()

◆ getContext()

◆ getFunctionStats()

◆ getOutput()

◆ getOutputs()

◆ getProfileID()

◆ getTemplated()

◆ getTransactionProfiler()

◆ instance()

◆ logData()

◆ logDataPageOutputOnly()

◆ profileIn()

◆ profileOut()

◆ replaceStubInstance()

◆ scopedProfileIn()

◆ scopedProfileOut()

◆ setAllowOutput()

◆ setContext()

◆ setProfileID()

◆ setTemplated()

Member Data Documentation

◆ $allowOutput

◆ $context

◆ $instance

◆ $params

◆ $profileID

◆ $trxProfiler