MediaWiki
master
|
Profiler base class that defines the interface and some shared functionality. More...
Public Member Functions | |
__construct (array $params) | |
close () | |
Close opened profiling sections. More... | |
getAllowOutput () | |
Whether appending profiles is allowed. More... | |
getContentType () | |
Get the Content-Type for deciding how to format appended profile output. More... | |
getContext () | |
getFunctionStats () | |
Get the aggregated inclusive profiling data for each method. More... | |
getOutput () | |
Returns a profiling output to be stored in debug file. More... | |
getProfileID () | |
getTransactionProfiler () | |
logData () | |
Log data to all the applicable backing stores. More... | |
logDataPageOutputOnly () | |
Log the data to the script/request output for all ProfilerOutput instances that do so. More... | |
scopedProfileIn ( $section) | |
Mark the start of a custom profiling frame (e.g. More... | |
scopedProfileOut (SectionProfileCallback &$section=null) | |
setAllowOutput () | |
Enable appending profiles to standard output. More... | |
setContext ( $context) | |
setProfileID ( $id) | |
Static Public Member Functions | |
static | init (array $profilerConf) |
static | instance () |
Singleton. More... | |
Protected Attributes | |
IContextSource | $context = null |
Current request context. More... | |
LoggerInterface | $logger |
array | $params = [] |
All of the params passed from $wgProfiler. More... | |
string false | $profileID = false |
Profiler ID for bucketing data. More... | |
TransactionProfiler | $trxProfiler |
Profiler base class that defines the interface and some shared functionality.
Definition at line 36 of file Profiler.php.
Profiler::__construct | ( | array | $params | ) |
array | $params | See $wgProfiler. |
Reimplemented in ProfilerXhprof, ProfilerSectionOnly, and ProfilerExcimer.
Definition at line 56 of file Profiler.php.
References $params.
|
abstract |
Close opened profiling sections.
Reimplemented in ProfilerXhprof, ProfilerStub, ProfilerSectionOnly, and ProfilerExcimer.
Profiler::getAllowOutput | ( | ) |
Whether appending profiles is allowed.
Definition at line 304 of file Profiler.php.
Profiler::getContentType | ( | ) |
Get the Content-Type for deciding how to format appended profile output.
Disabled by default. Enable via setAllowOutput().
Definition at line 278 of file Profiler.php.
References $header.
Profiler::getContext | ( | ) |
Definition at line 149 of file Profiler.php.
References RequestContext\getMain(), and wfDeprecated().
|
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.
Reimplemented in ProfilerXhprof, ProfilerStub, ProfilerSectionOnly, and ProfilerExcimer.
|
abstract |
Returns a profiling output to be stored in debug file.
Reimplemented in ProfilerXhprof, ProfilerStub, ProfilerSectionOnly, and ProfilerExcimer.
Profiler::getProfileID | ( | ) |
Definition at line 126 of file Profiler.php.
References WikiMap\getCurrentWikiDbDomain().
Profiler::getTransactionProfiler | ( | ) |
|
staticfinal |
array | $profilerConf | Value from $wgProfiler |
Definition at line 69 of file Profiler.php.
References $params.
|
staticfinal |
Singleton.
Definition at line 107 of file Profiler.php.
Referenced by MWLBFactory\applyDefaultConfig(), MediaWiki\Auth\AuthManager\autoCreateUser(), FileBackendGroup\config(), MediaWiki\Http\HttpRequestFactory\create(), SpecialConfirmEmail\execute(), SpecialEmailInvalidate\execute(), ApiRollback\execute(), MediaWiki\SpecialPage\SpecialPageFactory\executePath(), LCStoreDB\finishWrite(), SkinTemplate\outputPage(), MediaWiki\restInPeace(), ApiMain\setRequestExpectations(), Maintenance\shutdown(), and wfLoadMain().
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.
Reimplemented in ProfilerStub.
Definition at line 219 of file Profiler.php.
Profiler::logDataPageOutputOnly | ( | ) |
Log the data to the script/request output for all ProfilerOutput instances that do so.
MWException |
Reimplemented in ProfilerStub.
Definition at line 249 of file Profiler.php.
|
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.
string | $section |
Reimplemented in ProfilerXhprof, ProfilerStub, ProfilerSectionOnly, and ProfilerExcimer.
Profiler::scopedProfileOut | ( | SectionProfileCallback & | $section = null | ) |
SectionProfileCallback | null | &$section |
Definition at line 167 of file Profiler.php.
Profiler::setAllowOutput | ( | ) |
Enable appending profiles to standard output.
Definition at line 294 of file Profiler.php.
Profiler::setContext | ( | $context | ) |
IContextSource | $context |
Definition at line 139 of file Profiler.php.
References wfDeprecated().
Profiler::setProfileID | ( | $id | ) |
string | $id |
Definition at line 119 of file Profiler.php.
|
protected |
Current request context.
Definition at line 42 of file Profiler.php.
|
protected |
Definition at line 46 of file Profiler.php.
|
protected |
All of the params passed from $wgProfiler.
Definition at line 40 of file Profiler.php.
Referenced by __construct(), ProfilerExcimer\__construct(), ProfilerSectionOnly\__construct(), ProfilerXhprof\__construct(), and init().
|
protected |
Profiler ID for bucketing data.
Definition at line 38 of file Profiler.php.
|
protected |
Definition at line 44 of file Profiler.php.