MediaWiki  REL1_31
Profiler.php
Go to the documentation of this file.
1 <?php
24 use Wikimedia\ScopedCallback;
26 
33 abstract class Profiler {
35  protected $profileID = false;
37  protected $templated = false;
39  protected $params = [];
41  protected $context = null;
43  protected $trxProfiler;
45  private static $instance = null;
46 
50  public function __construct( array $params ) {
51  if ( isset( $params['profileID'] ) ) {
52  $this->profileID = $params['profileID'];
53  }
54  $this->params = $params;
55  $this->trxProfiler = new TransactionProfiler();
56  }
57 
62  final public static function instance() {
63  if ( self::$instance === null ) {
65 
66  $params = [
67  'class' => ProfilerStub::class,
68  'sampling' => 1,
69  'threshold' => $wgProfileLimit,
70  'output' => [],
71  ];
72  if ( is_array( $wgProfiler ) ) {
73  $params = array_merge( $params, $wgProfiler );
74  }
75 
76  $inSample = mt_rand( 0, $params['sampling'] - 1 ) === 0;
77  // wfIsCLI() is not available yet
78  if ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' || !$inSample ) {
79  $params['class'] = ProfilerStub::class;
80  }
81 
82  if ( !is_array( $params['output'] ) ) {
83  $params['output'] = [ $params['output'] ];
84  }
85 
86  self::$instance = new $params['class']( $params );
87  }
88  return self::$instance;
89  }
90 
98  final public static function replaceStubInstance( Profiler $profiler ) {
99  if ( self::$instance && !( self::$instance instanceof ProfilerStub ) ) {
100  throw new MWException( 'Could not replace non-stub profiler instance.' );
101  } else {
102  self::$instance = $profiler;
103  }
104  }
105 
109  public function setProfileID( $id ) {
110  $this->profileID = $id;
111  }
112 
116  public function getProfileID() {
117  if ( $this->profileID === false ) {
118  return wfWikiID();
119  } else {
120  return $this->profileID;
121  }
122  }
123 
130  public function setContext( $context ) {
131  $this->context = $context;
132  }
133 
140  public function getContext() {
141  if ( $this->context ) {
142  return $this->context;
143  } else {
144  wfDebug( __METHOD__ . " called and \$context is null. " .
145  "Return RequestContext::getMain(); for sanity\n" );
146  return RequestContext::getMain();
147  }
148  }
149 
150  // Kept BC for now, remove when possible
151  public function profileIn( $functionname ) {
152  }
153 
154  public function profileOut( $functionname ) {
155  }
156 
165  abstract public function scopedProfileIn( $section );
166 
170  public function scopedProfileOut( SectionProfileCallback &$section = null ) {
171  $section = null;
172  }
173 
178  public function getTransactionProfiler() {
179  return $this->trxProfiler;
180  }
181 
185  abstract public function close();
186 
194  private function getOutputs() {
195  $outputs = [];
196  foreach ( $this->params['output'] as $outputType ) {
197  // The class may be specified as either the full class name (for
198  // example, 'ProfilerOutputStats') or (for backward compatibility)
199  // the trailing portion of the class name (for example, 'stats').
200  $outputClass = strpos( $outputType, 'ProfilerOutput' ) === false
201  ? 'ProfilerOutput' . ucfirst( $outputType )
202  : $outputType;
203  if ( !class_exists( $outputClass ) ) {
204  throw new MWException( "'$outputType' is an invalid output type" );
205  }
206  $outputInstance = new $outputClass( $this, $this->params );
207  if ( $outputInstance->canUse() ) {
208  $outputs[] = $outputInstance;
209  }
210  }
211  return $outputs;
212  }
213 
219  public function logData() {
220  $request = $this->getContext()->getRequest();
221 
222  $timeElapsed = $request->getElapsedTime();
223  $timeElapsedThreshold = $this->params['threshold'];
224  if ( $timeElapsed <= $timeElapsedThreshold ) {
225  return;
226  }
227 
228  $outputs = $this->getOutputs();
229  if ( !$outputs ) {
230  return;
231  }
232 
233  $stats = $this->getFunctionStats();
234  foreach ( $outputs as $output ) {
235  $output->log( $stats );
236  }
237  }
238 
245  public function logDataPageOutputOnly() {
246  foreach ( $this->getOutputs() as $output ) {
247  if ( $output instanceof ProfilerOutputText ) {
248  $stats = $this->getFunctionStats();
249  $output->log( $stats );
250  }
251  }
252  }
253 
260  public function getContentType() {
261  foreach ( headers_list() as $header ) {
262  if ( preg_match( '#^content-type: (\w+/\w+);?#i', $header, $m ) ) {
263  return $m[1];
264  }
265  }
266  return null;
267  }
268 
274  public function setTemplated( $t ) {
275  $this->templated = $t;
276  }
277 
283  public function getTemplated() {
284  return $this->templated;
285  }
286 
313  abstract public function getFunctionStats();
314 
320  abstract public function getOutput();
321 }
$wgProfileLimit
$wgProfileLimit
Only record profiling info for pages that took longer than this.
Definition: DefaultSettings.php:6356
Profiler\getTemplated
getTemplated()
Was this call as templated or not.
Definition: Profiler.php:283
Profiler\getTransactionProfiler
getTransactionProfiler()
Definition: Profiler.php:178
Profiler\setTemplated
setTemplated( $t)
Mark this call as templated or not.
Definition: Profiler.php:274
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Profiler\replaceStubInstance
static replaceStubInstance(Profiler $profiler)
Replace the current profiler with $profiler if no non-stub profiler is set.
Definition: Profiler.php:98
Profiler\instance
static instance()
Singleton.
Definition: Profiler.php:62
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2255
Profiler\getOutput
getOutput()
Returns a profiling output to be stored in debug file.
Profiler\getContentType
getContentType()
Get the content type sent out to the client.
Definition: Profiler.php:260
Profiler\$instance
static Profiler $instance
Definition: Profiler.php:45
ProfilerStub
Stub profiler that does nothing.
Definition: ProfilerStub.php:29
Profiler\$profileID
string bool $profileID
Profiler ID for bucketing data.
Definition: Profiler.php:35
Profiler\$context
IContextSource $context
Current request context.
Definition: Profiler.php:41
Profiler\scopedProfileIn
scopedProfileIn( $section)
Mark the start of a custom profiling frame (e.g.
ProfilerOutputText
The least sophisticated profiler output class possible, view your source! :)
Definition: ProfilerOutputText.php:30
Profiler\getOutputs
getOutputs()
Get all usable outputs.
Definition: Profiler.php:194
Profiler\$trxProfiler
TransactionProfiler $trxProfiler
Definition: Profiler.php:43
SectionProfileCallback
Subclass ScopedCallback to avoid call_user_func_array(), which is slow.
Definition: SectionProfiler.php:511
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Profiler\profileOut
profileOut( $functionname)
Definition: Profiler.php:154
MWException
MediaWiki exception.
Definition: MWException.php:26
Profiler\profileIn
profileIn( $functionname)
Definition: Profiler.php:151
Profiler\close
close()
Close opened profiling sections.
Profiler
Profiler base class that defines the interface and some trivial functionality.
Definition: Profiler.php:33
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
Profiler\__construct
__construct(array $params)
Definition: Profiler.php:50
Profiler\$templated
bool $templated
Whether MediaWiki is in a SkinTemplate output context.
Definition: Profiler.php:37
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2763
Profiler\setContext
setContext( $context)
Sets the context for this Profiler.
Definition: Profiler.php:130
$header
$header
Definition: updateCredits.php:35
Profiler\logData
logData()
Log the data to some store or even the page output.
Definition: Profiler.php:219
Profiler\setProfileID
setProfileID( $id)
Definition: Profiler.php:109
$wgProfiler
if(!defined( 'MEDIAWIKI')) $wgProfiler
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
Definition: Setup.php:41
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
Profiler\getContext
getContext()
Gets the context for this Profiler.
Definition: Profiler.php:140
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
Profiler\getFunctionStats
getFunctionStats()
Get the aggregated inclusive profiling data for each method.
Profiler\logDataPageOutputOnly
logDataPageOutputOnly()
Output current data to the page output if configured to do so.
Definition: Profiler.php:245
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3022
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Profiler\$params
array $params
All of the params passed from $wgProfiler.
Definition: Profiler.php:39
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
$t
$t
Definition: testCompression.php:69
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
Wikimedia\Rdbms\TransactionProfiler
Helper class that detects high-contention DB queries via profiling calls.
Definition: TransactionProfiler.php:38
Profiler\getProfileID
getProfileID()
Definition: Profiler.php:116
Profiler\scopedProfileOut
scopedProfileOut(SectionProfileCallback &$section=null)
Definition: Profiler.php:170