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

Inheritance diagram for Profiler:

[legend]

Collaboration diagram for Profiler:

[legend]

Public Member Functions
	__construct (array $params)

	close ()
	Close opened profiling sections.

	getContentType ()
	Get the content type sent out to the client.

	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 some store or even the page output.

	logDataPageOutputOnly ()
	Output current data to the page output if configured to do so.

	profileIn ( $functionname)

	profileOut ( $functionname)

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

	scopedProfileOut (SectionProfileCallback &$section=null)

	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.

bool	$templated = false
	Whether MediaWiki is in a SkinTemplate output context.

TransactionProfiler	$trxProfiler

Private Member Functions
	getOutputs ()
	Get all usable outputs.

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

Reimplemented in ProfilerSectionOnly, and ProfilerXhprof.

Definition at line 50 of file Profiler.php.

References $params.

Member Function Documentation

◆ close()

Profiler::close ( )

abstract

Close opened profiling sections.

Reimplemented in ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

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

References $header.

◆ getContext()

Profiler::getContext ( )

Gets the context for this Profiler.

Returns: IContextSource

Since: 1.25

Definition at line 140 of file Profiler.php.

References $context, and 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 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 ProfilerSectionOnly, ProfilerStub, and ProfilerXhprof.

◆ getOutputs()

Profiler::getOutputs ( )

private

Get all usable outputs.

Exceptions

MWException

Returns: ProfilerOutput[]

Since: 1.25

Definition at line 194 of file Profiler.php.

Referenced by logData(), and logDataPageOutputOnly().

◆ getProfileID()

Profiler::getProfileID ( )

Returns: string

Definition at line 116 of file Profiler.php.

References wfWikiID().

◆ getTemplated()

Profiler::getTemplated ( )

Was this call as templated or not.

Returns: bool

Definition at line 283 of file Profiler.php.

◆ getTransactionProfiler()

Profiler::getTransactionProfiler ( )

Returns: TransactionProfiler

Since: 1.25

Definition at line 178 of file Profiler.php.

◆ instance()

static Profiler::instance ( )

staticfinal

Singleton.

Returns: Profiler

Definition at line 62 of file Profiler.php.

References $params, $wgProfileLimit, and $wgProfiler.

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

◆ logData()

Profiler::logData ( )

Log the data to some store or even the page output.

Since: 1.25

Reimplemented in ProfilerStub.

Definition at line 219 of file Profiler.php.

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

◆ logDataPageOutputOnly()

Profiler::logDataPageOutputOnly ( )

Output current data to the page output if configured to do so.

Exceptions

MWException

Since: 1.26

Reimplemented in ProfilerStub.

Definition at line 245 of file Profiler.php.

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

◆ profileIn()

Profiler::profileIn ( $functionname )

Definition at line 151 of file Profiler.php.

◆ profileOut()

Profiler::profileOut ( $functionname )

Definition at line 154 of file Profiler.php.

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

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

◆ scopedProfileOut()

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

Parameters

SectionProfileCallback | null &$section

Definition at line 170 of file Profiler.php.

References $section.

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

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

◆ $templated

bool Profiler::$templated = false

protected

Whether MediaWiki is in a SkinTemplate output context.

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

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ close()

◆ getContentType()

◆ getContext()

◆ getFunctionStats()

◆ getOutput()

◆ getOutputs()

◆ getProfileID()

◆ getTemplated()

◆ getTransactionProfiler()

◆ instance()

◆ logData()

◆ logDataPageOutputOnly()

◆ profileIn()

◆ profileOut()

◆ replaceStubInstance()

◆ scopedProfileIn()

◆ scopedProfileOut()

◆ setContext()

◆ setProfileID()

◆ setTemplated()

Member Data Documentation

◆ $context

◆ $instance

◆ $params

◆ $profileID

◆ $templated

◆ $trxProfiler