MediaWiki  1.30.0
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',
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  if ( PHP_SAPI === 'cli' || !$inSample ) {
78  $params['class'] = 'ProfilerStub';
79  }
80 
81  if ( !is_array( $params['output'] ) ) {
82  $params['output'] = [ $params['output'] ];
83  }
84 
85  self::$instance = new $params['class']( $params );
86  }
87  return self::$instance;
88  }
89 
97  final public static function replaceStubInstance( Profiler $profiler ) {
98  if ( self::$instance && !( self::$instance instanceof ProfilerStub ) ) {
99  throw new MWException( 'Could not replace non-stub profiler instance.' );
100  } else {
101  self::$instance = $profiler;
102  }
103  }
104 
108  public function setProfileID( $id ) {
109  $this->profileID = $id;
110  }
111 
115  public function getProfileID() {
116  if ( $this->profileID === false ) {
117  return wfWikiID();
118  } else {
119  return $this->profileID;
120  }
121  }
122 
129  public function setContext( $context ) {
130  $this->context = $context;
131  }
132 
139  public function getContext() {
140  if ( $this->context ) {
141  return $this->context;
142  } else {
143  wfDebug( __METHOD__ . " called and \$context is null. " .
144  "Return RequestContext::getMain(); for sanity\n" );
145  return RequestContext::getMain();
146  }
147  }
148 
149  // Kept BC for now, remove when possible
150  public function profileIn( $functionname ) {
151  }
152 
153  public function profileOut( $functionname ) {
154  }
155 
164  abstract public function scopedProfileIn( $section );
165 
169  public function scopedProfileOut( SectionProfileCallback &$section = null ) {
170  $section = null;
171  }
172 
177  public function getTransactionProfiler() {
178  return $this->trxProfiler;
179  }
180 
184  abstract public function close();
185 
193  private function getOutputs() {
194  $outputs = [];
195  foreach ( $this->params['output'] as $outputType ) {
196  // The class may be specified as either the full class name (for
197  // example, 'ProfilerOutputStats') or (for backward compatibility)
198  // the trailing portion of the class name (for example, 'stats').
199  $outputClass = strpos( $outputType, 'ProfilerOutput' ) === false
200  ? 'ProfilerOutput' . ucfirst( $outputType )
201  : $outputType;
202  if ( !class_exists( $outputClass ) ) {
203  throw new MWException( "'$outputType' is an invalid output type" );
204  }
205  $outputInstance = new $outputClass( $this, $this->params );
206  if ( $outputInstance->canUse() ) {
207  $outputs[] = $outputInstance;
208  }
209  }
210  return $outputs;
211  }
212 
218  public function logData() {
219  $request = $this->getContext()->getRequest();
220 
221  $timeElapsed = $request->getElapsedTime();
222  $timeElapsedThreshold = $this->params['threshold'];
223  if ( $timeElapsed <= $timeElapsedThreshold ) {
224  return;
225  }
226 
227  $outputs = $this->getOutputs();
228  if ( !$outputs ) {
229  return;
230  }
231 
232  $stats = $this->getFunctionStats();
233  foreach ( $outputs as $output ) {
234  $output->log( $stats );
235  }
236  }
237 
244  public function logDataPageOutputOnly() {
245  foreach ( $this->getOutputs() as $output ) {
246  if ( $output instanceof ProfilerOutputText ) {
247  $stats = $this->getFunctionStats();
248  $output->log( $stats );
249  }
250  }
251  }
252 
259  public function getContentType() {
260  foreach ( headers_list() as $header ) {
261  if ( preg_match( '#^content-type: (\w+/\w+);?#i', $header, $m ) ) {
262  return $m[1];
263  }
264  }
265  return null;
266  }
267 
273  public function setTemplated( $t ) {
274  $this->templated = $t;
275  }
276 
282  public function getTemplated() {
283  return $this->templated;
284  }
285 
312  abstract public function getFunctionStats();
313 
319  abstract public function getOutput();
320 }
$wgProfileLimit
$wgProfileLimit
Only record profiling info for pages that took longer than this.
Definition: DefaultSettings.php:6310
Profiler\getTemplated
getTemplated()
Was this call as templated or not.
Definition: Profiler.php:282
Profiler\getTransactionProfiler
getTransactionProfiler()
Definition: Profiler.php:177
Profiler\setTemplated
setTemplated( $t)
Mark this call as templated or not.
Definition: Profiler.php:273
Profiler\replaceStubInstance
static replaceStubInstance(Profiler $profiler)
Replace the current profiler with $profiler if no non-stub profiler is set.
Definition: Profiler.php:97
Profiler\instance
static instance()
Singleton.
Definition: Profiler.php:62
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:259
Profiler\$instance
static Profiler $instance
Definition: Profiler.php:45
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
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
$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:2198
Profiler\getOutputs
getOutputs()
Get all usable outputs.
Definition: Profiler.php:193
Profiler\$trxProfiler
TransactionProfiler $trxProfiler
Definition: Profiler.php:43
SectionProfileCallback
Subclass ScopedCallback to avoid call_user_func_array(), which is slow.
Definition: SectionProfiler.php:505
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:35
Profiler\profileOut
profileOut( $functionname)
Definition: Profiler.php:153
$wgProfiler
$wgProfiler
Definition: PreConfigSetup.php:40
MWException
MediaWiki exception.
Definition: MWException.php:26
Profiler\profileIn
profileIn( $functionname)
Definition: Profiler.php:150
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:93
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:1047
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
$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:2581
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2807
Profiler\setContext
setContext( $context)
Sets the context for this Profiler.
Definition: Profiler.php:129
$header
$header
Definition: updateCredits.php:35
Profiler\logData
logData()
Log the data to some store or even the page output.
Definition: Profiler.php:218
Profiler\setProfileID
setProfileID( $id)
Definition: Profiler.php:108
RequestContext\getMain
static getMain()
Static methods.
Definition: RequestContext.php:470
Profiler\getContext
getContext()
Gets the context for this Profiler.
Definition: Profiler.php:139
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:55
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:244
$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:2981
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:9
Profiler\$params
array $params
All of the params passed from $wgProfiler.
Definition: Profiler.php:39
$t
$t
Definition: testCompression.php:67
Wikimedia\Rdbms\TransactionProfiler
Helper class that detects high-contention DB queries via profiling calls.
Definition: TransactionProfiler.php:38
Profiler\getProfileID
getProfileID()
Definition: Profiler.php:115
Profiler\scopedProfileOut
scopedProfileOut(SectionProfileCallback &$section=null)
Definition: Profiler.php:169
array
the array() calling protocol came about after MediaWiki 1.4rc1.