MediaWiki
1.28.0
|
Profiler base class that defines the interface and some trivial functionality. More...
Public Member Functions | |
__construct (array $params) | |
close () | |
Close opened profiling sections. More... | |
getContentType () | |
Get the content type sent out to the client. More... | |
getContext () | |
Gets the context for this Profiler. More... | |
getFunctionStats () | |
Get the aggregated inclusive profiling data for each method. More... | |
getOutput () | |
Returns a profiling output to be stored in debug file. More... | |
getProfileID () | |
getTemplated () | |
Was this call as templated or not. More... | |
getTransactionProfiler () | |
logData () | |
Log the data to some store or even the page output. More... | |
logDataPageOutputOnly () | |
Output current data to the page output if configured to do so. More... | |
profileIn ($functionname) | |
profileOut ($functionname) | |
scopedProfileIn ($section) | |
Mark the start of a custom profiling frame (e.g. More... | |
scopedProfileOut (SectionProfileCallback &$section=null) | |
setContext ($context) | |
Sets the context for this Profiler. More... | |
setProfileID ($id) | |
setTemplated ($t) | |
Mark this call as templated or not. More... | |
Static Public Member Functions | |
static | instance () |
Singleton. More... | |
static | replaceStubInstance (Profiler $profiler) |
Replace the current profiler with $profiler if no non-stub profiler is set. More... | |
Protected Attributes | |
IContextSource | $context = null |
Current request context. More... | |
array | $params = [] |
All of the params passed from $wgProfiler. More... | |
string bool | $profileID = false |
Profiler ID for bucketing data. More... | |
bool | $templated = false |
Whether MediaWiki is in a SkinTemplate output context. More... | |
TransactionProfiler | $trxProfiler |
Private Member Functions | |
getOutputs () | |
Get all usable outputs. More... | |
Static Private Attributes | |
static Profiler | $instance = null |
Profiler base class that defines the interface and some trivial functionality.
Definition at line 32 of file Profiler.php.
Profiler::__construct | ( | array | $params | ) |
|
abstract |
Close opened profiling sections.
Profiler::getContentType | ( | ) |
Get the content type sent out to the client.
Used for profilers that output instead of store data.
Definition at line 258 of file Profiler.php.
Profiler::getContext | ( | ) |
Gets the context for this Profiler.
Definition at line 138 of file Profiler.php.
References $context, RequestContext\getMain(), and wfDebug().
Referenced by logData().
|
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.
Referenced by logData(), and logDataPageOutputOnly().
|
abstract |
Returns a profiling output to be stored in debug file.
|
private |
Get all usable outputs.
MWException |
Definition at line 192 of file Profiler.php.
References as.
Referenced by logData(), and logDataPageOutputOnly().
Profiler::getProfileID | ( | ) |
Profiler::getTemplated | ( | ) |
Was this call as templated or not.
Definition at line 281 of file Profiler.php.
References $templated.
Profiler::getTransactionProfiler | ( | ) |
Definition at line 176 of file Profiler.php.
References $trxProfiler.
|
staticfinal |
Singleton.
Definition at line 61 of file Profiler.php.
References $params, $wgProfiler, and global.
Referenced by Maintenance\activateProfiler(), MWLBFactory\applyDefaultConfig(), MediaWiki\Auth\AuthManager\autoCreateUser(), FileBackendGroup\config(), MediaWiki\doPostOutputShutdown(), IndexPager\doQuery(), EmailInvalidation\execute(), EmailConfirmation\execute(), SpecialPageFactory\executePath(), MWHttpRequest\factory(), MediaWiki\main(), SkinTemplate\outputPage(), MediaWiki\performAction(), MediaWiki\restInPeace(), JobRunner\run(), and ApiMain\setRequestExpectations().
Profiler::logData | ( | ) |
Log the data to some store or even the page output.
Definition at line 217 of file Profiler.php.
References $output, $request, as, getContext(), getFunctionStats(), and getOutputs().
Profiler::logDataPageOutputOnly | ( | ) |
Output current data to the page output if configured to do so.
MWException |
Definition at line 243 of file Profiler.php.
References $output, as, getFunctionStats(), and getOutputs().
Profiler::profileIn | ( | $functionname | ) |
Definition at line 149 of file Profiler.php.
Profiler::profileOut | ( | $functionname | ) |
Definition at line 152 of file Profiler.php.
|
staticfinal |
Replace the current profiler with $profiler if no non-stub profiler is set.
Profiler | $profiler |
MWException |
Definition at line 96 of file Profiler.php.
Referenced by Maintenance\activateProfiler().
|
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 |
Profiler::scopedProfileOut | ( | SectionProfileCallback & | $section = null | ) |
SectionProfileCallback | $section |
Definition at line 168 of file Profiler.php.
References $section.
Profiler::setContext | ( | $context | ) |
Sets the context for this Profiler.
IContextSource | $context |
Definition at line 128 of file Profiler.php.
References $context.
Profiler::setProfileID | ( | $id | ) |
string | $id |
Definition at line 107 of file Profiler.php.
Profiler::setTemplated | ( | $t | ) |
Mark this call as templated or not.
bool | $t |
Definition at line 272 of file Profiler.php.
References $t.
|
protected |
Current request context.
Definition at line 40 of file Profiler.php.
Referenced by getContext(), and setContext().
|
staticprivate |
Definition at line 44 of file Profiler.php.
|
protected |
All of the params passed from $wgProfiler.
Definition at line 38 of file Profiler.php.
Referenced by ProfilerSectionOnly\__construct(), __construct(), ProfilerXhprof\__construct(), and instance().
Profiler ID for bucketing data.
Definition at line 34 of file Profiler.php.
Referenced by getProfileID().
|
protected |
Whether MediaWiki is in a SkinTemplate output context.
Definition at line 36 of file Profiler.php.
Referenced by getTemplated().
|
protected |
Definition at line 42 of file Profiler.php.
Referenced by getTransactionProfiler().