MediaWiki REL1_28
profileinfo.php
Go to the documentation of this file.
1<?php
28// This endpoint is supposed to be independent of request cookies and other
29// details of the session. Log warnings for violations of the no-session
30// constraint.
31define( 'MW_NO_SESSION', 'warn' );
32
33ini_set( 'zlib.output_compression', 'off' );
34
36require __DIR__ . '/includes/WebStart.php';
37
38header( 'Content-Type: text/html; charset=utf-8' );
39
40?>
41<!DOCTYPE html>
42<html>
43<head>
44 <meta charset="UTF-8" />
45 <title>Profiling data</title>
46 <style>
47 /* noc.wikimedia.org/base.css */
48
49 * {
50 margin: 0;
51 padding: 0;
52 }
53
54 body {
55 padding: 0.5em 1em;
56 background: #fff;
57 font: 14px/1.6 sans-serif;
58 color: #333;
59 }
60
61 p, ul, ol, table {
62 margin: 0.5em 0;
63 }
64
65 a {
66 color: #0645AD;
67 text-decoration: none;
68 }
69
70 a:hover {
71 text-decoration: underline;
72 }
73
84 table {
85 max-width: 100%;
86 background-color: transparent;
87 border-collapse: collapse;
88 border-spacing: 0;
89 }
90
91 .table {
92 width: 100%;
93 margin-bottom: 20px;
94 }
95
96 .table th,
97 .table td {
98 padding: 0.1em;
99 text-align: left;
100 vertical-align: top;
101 border-top: 1px solid #ddd;
102 }
103
104 .table th {
105 font-weight: bold;
106 }
107
108 .table thead th {
109 vertical-align: bottom;
110 }
111
112 .table thead:first-child tr:first-child th,
113 .table thead:first-child tr:first-child td {
114 border-top: 0;
115 }
116
117 .table tbody + tbody {
118 border-top: 2px solid #ddd;
119 }
120
121 .table-condensed th,
122 .table-condensed td {
123 padding: 4px 5px;
124 }
125
126 .table-striped tbody tr:nth-child(odd) td,
127 .table-striped tbody tr:nth-child(odd) th {
128 background-color: #f9f9f9;
129 }
130
131 .table-hover tbody tr:hover td,
132 .table-hover tbody tr:hover th {
133 background-color: #f5f5f5;
134 }
135
136 hr {
137 margin: 20px 0;
138 border: 0;
139 border-top: 1px solid #eee;
140 border-bottom: 1px solid #fff;
141 }
142 </style>
143</head>
144<body>
145<?php
146
147if ( !$wgEnableProfileInfo ) {
148 echo '<p>Disabled</p>'
149 . '</body></html>';
150 exit( 1 );
151}
152
154
155if ( !$dbr->tableExists( 'profiling' ) ) {
156 echo '<p>No <code>profiling</code> table exists, so we can\'t show you anything.</p>'
157 . '<p>If you want to log profiling data, enable <code>$wgProfiler[\'output\'] = \'db\'</code>'
158 . ' in your StartProfiler.php and run <code>maintenance/update.php</code> to'
159 . ' create the profiling table.'
160 . '</body></html>';
161 exit( 1 );
162}
163
165if ( isset( $_REQUEST['expand'] ) ) {
166 foreach ( explode( ',', $_REQUEST['expand'] ) as $f ) {
167 $expand[$f] = true;
168 }
169}
170
171// @codingStandardsIgnoreStart
173 // @codingStandardsIgnoreEnd
174
175 public $name;
176 public $count;
177 public $time;
178 public $children;
179
181
182 public function __construct( $name, $count, $time, $memory ) {
183 $this->name = $name;
184 $this->count = $count;
185 $this->time = $time;
186 $this->memory = $memory;
187 $this->children = [];
188 }
189
190 public function add_child( $child ) {
191 $this->children[] = $child;
192 }
193
194 public function display( $expand, $indent = 0.0 ) {
195 usort( $this->children, 'compare_point' );
196
197 $ex = isset( $expand[$this->name()] );
198
199 $anchor = str_replace( '"', '', $this->name() );
200
201 if ( !$ex ) {
202 if ( count( $this->children ) ) {
203 $url = getEscapedProfileUrl( false, false, $expand + [ $this->name() => true ] );
204 $extet = " <a id=\"{$anchor}\" href=\"{$url}#{$anchor}\">[+]</a>";
205 } else {
206 $extet = '';
207 }
208 } else {
209 $e = [];
210 foreach ( $expand as $name => $ep ) {
211 if ( $name != $this->name() ) {
212 $e += [ $name => $ep ];
213 }
214 }
215 $url = getEscapedProfileUrl( false, false, $e );
216 $extet = " <a id=\"{$anchor}\" href=\"{$url}#{$anchor}\">[–]</a>";
217 }
218 ?>
219 <tr>
220 <th>
221 <div style="margin-left: <?php echo (int)$indent; ?>em;">
222 <?php echo htmlspecialchars( str_replace( ',', ', ', $this->name() ) ) . $extet ?>
223 </div>
224 </th>
225 <?php //@codingStandardsIgnoreStart ?>
226 <td class="mw-profileinfo-timep"><?php echo @wfPercent( $this->time() / self::$totaltime * 100 ); ?></td>
227 <td class="mw-profileinfo-memoryp"><?php echo @wfPercent( $this->memory() / self::$totalmemory * 100 ); ?></td>
228 <td class="mw-profileinfo-count"><?php echo $this->count(); ?></td>
229 <td class="mw-profileinfo-cpr"><?php echo round( sprintf( '%.2f', $this->callsPerRequest() ), 2 ); ?></td>
230 <td class="mw-profileinfo-tpc"><?php echo round( sprintf( '%.2f', $this->timePerCall() ), 2 ); ?></td>
231 <td class="mw-profileinfo-mpc"><?php echo round( sprintf( '%.2f', $this->memoryPerCall() / 1024 ), 2 ); ?></td>
232 <td class="mw-profileinfo-tpr"><?php echo @round( sprintf( '%.2f', $this->time() / self::$totalcount ), 2 ); ?></td>
233 <td class="mw-profileinfo-mpr"><?php echo @round( sprintf( '%.2f', $this->memory() / self::$totalcount / 1024 ), 2 ); ?></td>
234 <?php //@codingStandardsIgnoreEnd ?>
235 </tr>
236 <?php
237 if ( $ex ) {
238 foreach ( $this->children as $child ) {
239 $child->display( $expand, $indent + 2 );
240 }
241 }
242 }
243
244 public function name() {
245 return $this->name;
246 }
247
248 public function count() {
249 return $this->count;
250 }
251
252 public function time() {
253 return $this->time;
254 }
255
256 public function memory() {
257 return $this->memory;
258 }
259
260 public function timePerCall() {
261 // @codingStandardsIgnoreStart
262 return @( $this->time / $this->count );
263 // @codingStandardsIgnoreEnd
264 }
265
266 public function memoryPerCall() {
267 // @codingStandardsIgnoreStart
268 return @( $this->memory / $this->count );
269 // @codingStandardsIgnoreEnd
270 }
271
272 public function callsPerRequest() {
273 // @codingStandardsIgnoreStart
274 return @( $this->count / self::$totalcount );
275 // @codingStandardsIgnoreEnd
276 }
277
278 public function timePerRequest() {
279 // @codingStandardsIgnoreStart
280 return @( $this->time / self::$totalcount );
281 // @codingStandardsIgnoreEnd
282 }
283
284 public function memoryPerRequest() {
285 // @codingStandardsIgnoreStart
286 return @( $this->memory / self::$totalcount );
287 // @codingStandardsIgnoreEnd
288 }
289
290 public function fmttime() {
291 return sprintf( '%5.02f', $this->time );
292 }
293};
294
296 // @codingStandardsIgnoreStart
298 // @codingStandardsIgnoreEnd
299 switch ( $sort ) {
300 case 'name':
301 return strcmp( $a->name(), $b->name() );
302 case 'time':
303 return $a->time() > $b->time() ? -1 : 1;
304 case 'memory':
305 return $a->memory() > $b->memory() ? -1 : 1;
306 case 'count':
307 return $a->count() > $b->count() ? -1 : 1;
308 case 'time_per_call':
309 return $a->timePerCall() > $b->timePerCall() ? -1 : 1;
310 case 'memory_per_call':
311 return $a->memoryPerCall() > $b->memoryPerCall() ? -1 : 1;
312 case 'calls_per_req':
313 return $a->callsPerRequest() > $b->callsPerRequest() ? -1 : 1;
314 case 'time_per_req':
315 return $a->timePerRequest() > $b->timePerRequest() ? -1 : 1;
316 case 'memory_per_req':
317 return $a->memoryPerRequest() > $b->memoryPerRequest() ? -1 : 1;
318 }
319}
320
321$sorts = [ 'time', 'memory', 'count', 'calls_per_req', 'name',
322 'time_per_call', 'memory_per_call', 'time_per_req', 'memory_per_req' ];
323$sort = 'time';
324if ( isset( $_REQUEST['sort'] ) && in_array( $_REQUEST['sort'], $sorts ) ) {
325 $sort = $_REQUEST['sort'];
326}
327
328$res = $dbr->select(
329 'profiling',
330 '*',
331 [],
332 'profileinfo.php',
333 [ 'ORDER BY' => 'pf_name ASC' ]
334);
335
336if ( isset( $_REQUEST['filter'] ) ) {
337 $filter = $_REQUEST['filter'];
338} else {
339 $filter = '';
340}
341
342?>
343<form method="get" action="profileinfo.php">
344 <p>
345 <input type="text" name="filter" value="<?php echo htmlspecialchars( $filter ); ?>">
346 <input type="hidden" name="sort" value="<?php echo htmlspecialchars( $sort ); ?>">
347 <input type="hidden" name="expand" value="<?php
348 echo htmlspecialchars( implode( ",", array_keys( $expand ) ) );
349 ?>">
350 <input type="submit" value="Filter">
351 </p>
352</form>
353
354<table class="mw-profileinfo-table table table-striped table-hover">
355 <thead>
356 <tr>
357 <th><a href="<?php
358 echo getEscapedProfileUrl( false, 'name' );
359 ?>">Name</a></th>
360 <th><a href="<?php
361 echo getEscapedProfileUrl( false, 'time' );
362 ?>">Time (%)</a></th>
363 <th><a href="<?php
364 echo getEscapedProfileUrl( false, 'memory' );
365 ?>">Memory (%)</a></th>
366 <th><a href="<?php
367 echo getEscapedProfileUrl( false, 'count' );
368 ?>">Count</a></th>
369 <th><a href="<?php
370 echo getEscapedProfileUrl( false, 'calls_per_req' );
371 ?>">Calls/req</a></th>
372 <th><a href="<?php
373 echo getEscapedProfileUrl( false, 'time_per_call' );
374 ?>">ms/call</a></th>
375 <th><a href="<?php
376 echo getEscapedProfileUrl( false, 'memory_per_call' );
377 ?>">kb/call</a></th>
378 <th><a href="<?php
379 echo getEscapedProfileUrl( false, 'time_per_req' );
380 ?>">ms/req</a></th>
381 <th><a href="<?php
382 echo getEscapedProfileUrl( false, 'memory_per_req' );
383 ?>">kb/req</a></th>
384 </tr>
385 </thead>
386 <tbody>
387 <?php
391
392 function getEscapedProfileUrl( $_filter = false, $_sort = false, $_expand = false ) {
393 // @codingStandardsIgnoreStart
394 global $filter, $sort, $expand;
395 // @codingStandardsIgnoreEnd
396
397 if ( $_expand === false ) {
398 $_expand = $expand;
399 }
400
401 return htmlspecialchars(
402 '?' .
403 wfArrayToCgi( [
404 'filter' => $_filter ? $_filter : $filter,
405 'sort' => $_sort ? $_sort : $sort,
406 'expand' => implode( ',', array_keys( $_expand ) )
407 ] )
408 );
409 }
410
414
415 $last = false;
416 foreach ( $res as $o ) {
417 $next = new profile_point( $o->pf_name, $o->pf_count, $o->pf_time, $o->pf_memory );
418 if ( $next->name() == '-total' || $next->name() == 'main()' ) {
419 profile_point::$totaltime = $next->time();
420 profile_point::$totalcount = $next->count();
421 profile_point::$totalmemory = $next->memory();
422 }
423 if ( $last !== false ) {
424 if ( preg_match( '/^' . preg_quote( $last->name(), '/' ) . '/', $next->name() ) ) {
425 $last->add_child( $next );
426 continue;
427 }
428 }
429 $last = $next;
430 if ( preg_match( '/^query: /', $next->name() ) || preg_match( '/^query-m: /', $next->name() ) ) {
431 $sqltotal += $next->time();
432 $queries[] = $next;
433 } else {
434 $points[] = $next;
435 }
436 }
437
438 $s = new profile_point( 'SQL Queries', 0, $sqltotal, 0, 0 );
439 foreach ( $queries as $q ) {
440 $s->add_child( $q );
441 }
443
444 // @codingStandardsIgnoreStart
445 @usort( $points, 'compare_point' );
446 // @codingStandardsIgnoreEnd
447
448 foreach ( $points as $point ) {
449 if ( strlen( $filter ) && !strstr( $point->name(), $filter ) ) {
450 continue;
451 }
452
453 $point->display( $expand );
454 }
455 ?>
456 </tbody>
457</table>
458<hr />
459<p>Total time: <code><?php printf( '%5.02f', profile_point::$totaltime ); ?></code></p>
460
461<p>Total memory: <code><?php printf( '%5.02f', profile_point::$totalmemory / 1024 ); ?></code></p>
462<hr />
463</body>
464</html>
shown</td >< td > a href
in the sidebar</td >< td > font color
const DB_SLAVE
Definition Defines.php:28
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfPercent( $nr, $acc=2, $round=true)
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
static $totalmemory
display( $expand, $indent=0.0)
__construct( $name, $count, $time, $memory)
add_child( $child)
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition deferred.txt:16
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition design.txt:18
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition design.txt:12
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
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and local administrators to define code that will be run at certain points in the mainline code
Definition hooks.txt:28
null means default in associative array form
Definition hooks.txt:1940
returning false will NOT prevent logging $e
Definition hooks.txt:2110
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
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy like it should help lighten the load on the database servers by caching data and objects in memory
Definition memcached.txt:10
title
f9f9f9
width
Bar style
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN boolean columns are always mapped to as the code does not always treat the column as a and VARBINARY columns should simply be TEXT The only exception is when VARBINARY is used to store true binary data
Definition postgres.txt:43
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition postgres.txt:36
if(isset( $_REQUEST['sort']) &&in_array( $_REQUEST['sort'], $sorts)) $res
$points
$wgEnableProfileInfo
$queries
$sort
compare_point(profile_point $a, profile_point $b)
foreach( $res as $o) $s
getEscapedProfileUrl( $_filter=false, $_sort=false, $_expand=false)
$sorts
if(! $wgEnableProfileInfo) $dbr
$last
$sqltotal
if(! $dbr->tableExists( 'profiling')) $expand