3 * Simple interface for displaying request profile data stored in
4 * the wikis' primary database.
6 * See also https://www.mediawiki.org/wiki/Manual:Profiling.
8 * To add profiling information to the database:
10 * - set $wgProfiler['class'] in LocalSetings.php to a Profiler class other than ProfilerStub.
11 * - set $wgProfiler['output'] to 'db' to force the profiler to save its the
12 * information in the database.
13 * - apply the maintenance/archives/patch-profiling.sql patch to the database.
14 * - set $wgEnableProfileInfo to true.
16 * Copyright 2005 Kate Turner.
18 * Permission is hereby granted, free of charge, to any person obtaining a copy
19 * of this software and associated documentation files (the "Software"), to deal
20 * in the Software without restriction, including without limitation the rights
21 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
22 * copies of the Software, and to permit persons to whom the Software is
23 * furnished to do so, subject to the following conditions:
25 * The above copyright notice and this permission notice shall be included in
26 * all copies or substantial portions of the Software.
28 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
29 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
30 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
31 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
32 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
33 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
39 // This endpoint is supposed to be independent of request cookies and other
40 // details of the session. Enforce this constraint with respect to session use.
41 define( 'MW_NO_SESSION', 1 );
43 define( 'MW_ENTRY_POINT', 'profileinfo' );
45 ini_set( 'zlib.output_compression', 'off' );
47 require __DIR__
. '/includes/WebStart.php';
49 header( 'Content-Type: text/html; charset=utf-8' );
55 <meta charset
="UTF-8" />
56 <title
>Profiling data
</title
>
58 /* noc.wikimedia.org/base.css */
68 font
: 14px
/1.6 sans
-serif
;
78 text
-decoration
: none
;
82 text
-decoration
: underline
;
88 * Copyright 2012 Twitter, Inc
89 * Licensed under the Apache License v2.0
90 * http://www.apache.org/licenses/LICENSE-2.0
92 * Designed and built with all the love in the world @twitter by @mdo and @fat.
97 background
-color
: transparent
;
98 border
-collapse
: collapse
;
112 border
-top
: 1px solid
#ddd;
120 vertical
-align
: bottom
;
123 .table thead
:first
-child tr
:first
-child th
,
124 .table thead
:first
-child tr
:first
-child td
{
128 .table tbody + tbody
{
129 border
-top
: 2px solid
#ddd;
133 .table
-condensed td
{
137 .table
-striped tbody tr
:nth
-child(odd
) td
,
138 .table
-striped tbody tr
:nth
-child(odd
) th
{
139 background
-color
: #f9f9f9;
142 .table
-hover tbody tr
:hover td
,
143 .table
-hover tbody tr
:hover th
{
144 background
-color
: #f5f5f5;
150 border
-top
: 1px solid
#eee;
151 border
-bottom
: 1px solid
#fff;
158 if ( !$wgEnableProfileInfo ) {
159 echo '<p>Disabled</p>'
164 $dbr = wfGetDB( DB_REPLICA
);
166 if ( !$dbr->tableExists( 'profiling' ) ) {
167 echo '<p>No <code>profiling</code> table exists, so we can\'t show you anything.</p>'
168 . '<p>If you want to log profiling data, enable <code>$wgProfiler[\'output\'] = \'db\'</code>'
169 . ' in LocalSettings.php and run <code>maintenance/update.php</code> to'
170 . ' create the profiling table.'
176 if ( isset( $_REQUEST['expand'] ) ) {
177 foreach ( explode( ',', $_REQUEST['expand'] ) as $f ) {
182 // phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
183 class profile_point
{
190 public static $totaltime, $totalmemory, $totalcount;
192 public function __construct( $name, $count, $time, $memory ) {
194 $this->count
= $count;
196 $this->memory
= $memory;
197 $this->children
= [];
200 public function add_child( $child ) {
201 $this->children
[] = $child;
204 public function display( $expand, $indent = 0.0 ) {
205 usort( $this->children
, 'compare_point' );
207 $ex = isset( $expand[$this->name()] );
209 $anchor = str_replace( '"', '', $this->name() );
212 if ( count( $this->children
) ) {
213 $url = getEscapedProfileUrl( false, false, $expand +
[ $this->name() => true ] );
214 $extet = " <a id=\"{$anchor}\" href=\"{$url}#{$anchor}\">[+]</a>";
220 foreach ( $expand as $name => $ep ) {
221 if ( $name != $this->name() ) {
222 $e +
= [ $name => $ep ];
225 $url = getEscapedProfileUrl( false, false, $e );
226 $extet = " <a id=\"{$anchor}\" href=\"{$url}#{$anchor}\">[–]</a>";
231 <div style
="margin-left: <?php echo (int)$indent; ?>em;">
232 <?php
echo htmlspecialchars( str_replace( ',', ', ', $this->name() ) ) . $extet ?
>
235 <?php
// phpcs:disable Generic.Files.LineLength,Generic.PHP.NoSilencedErrors ?>
236 <td
class="mw-profileinfo-timep"><?php
echo @wfPercent
( $this->time() / self
::$totaltime * 100 ); ?
></td
>
237 <td
class="mw-profileinfo-memoryp"><?php
echo @wfPercent
( $this->memory() / self
::$totalmemory * 100 ); ?
></td
>
238 <td
class="mw-profileinfo-count"><?php
echo $this->count(); ?
></td
>
239 <td
class="mw-profileinfo-cpr"><?php
echo round( sprintf( '%.2f', $this->callsPerRequest() ), 2 ); ?
></td
>
240 <td
class="mw-profileinfo-tpc"><?php
echo round( sprintf( '%.2f', $this->timePerCall() ), 2 ); ?
></td
>
241 <td
class="mw-profileinfo-mpc"><?php
echo round( sprintf( '%.2f', $this->memoryPerCall() / 1024 ), 2 ); ?
></td
>
242 <td
class="mw-profileinfo-tpr"><?php
echo @round
( sprintf( '%.2f', $this->time() / self
::$totalcount ), 2 ); ?
></td
>
243 <td
class="mw-profileinfo-mpr"><?php
echo @round
( sprintf( '%.2f', $this->memory() / self
::$totalcount / 1024 ), 2 ); ?
></td
>
244 <?php
// phpcs:enable ?>
248 foreach ( $this->children
as $child ) {
249 $child->display( $expand, $indent +
2 );
254 public function name() {
258 public function count() {
262 public function time() {
266 public function memory() {
267 return $this->memory
;
270 public function timePerCall() {
271 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
272 return @( $this->time
/ $this->count
);
275 public function memoryPerCall() {
276 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
277 return @( $this->memory
/ $this->count
);
280 public function callsPerRequest() {
281 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
282 return @( $this->count
/ self
::$totalcount );
285 public function timePerRequest() {
286 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
287 return @( $this->time
/ self
::$totalcount );
290 public function memoryPerRequest() {
291 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
292 return @( $this->memory
/ self
::$totalcount );
295 public function fmttime() {
296 return sprintf( '%5.02f', $this->time
);
300 function compare_point( profile_point
$a, profile_point
$b ) {
301 // phpcs:ignore MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
307 return strcmp( $a->name(), $b->name() );
308 // Sorted descending:
310 return $b->time() <=> $a->time();
312 return $b->memory() <=> $a->memory();
314 return $b->count() <=> $a->count();
315 case 'time_per_call':
316 return $b->timePerCall() <=> $a->timePerCall();
317 case 'memory_per_call':
318 return $b->memoryPerCall() <=> $a->memoryPerCall();
319 case 'calls_per_req':
320 return $b->callsPerRequest() <=> $a->callsPerRequest();
322 return $b->timePerRequest() <=> $a->timePerRequest();
323 case 'memory_per_req':
324 return $b->memoryPerRequest() <=> $a->memoryPerRequest();
328 $sorts = [ 'time', 'memory', 'count', 'calls_per_req', 'name',
329 'time_per_call', 'memory_per_call', 'time_per_req', 'memory_per_req' ];
331 if ( isset( $_REQUEST['sort'] ) && in_array( $_REQUEST['sort'], $sorts ) ) {
332 $sort = $_REQUEST['sort'];
340 [ 'ORDER BY' => 'pf_name ASC' ]
343 $filter = $_REQUEST['filter'] ??
'';
346 <form method
="get" action
="profileinfo.php">
348 <input type
="text" name
="filter" value
="<?php echo htmlspecialchars( $filter ); ?>">
349 <input type
="hidden" name
="sort" value
="<?php echo htmlspecialchars( $sort ); ?>">
350 <input type
="hidden" name
="expand" value
="<?php
351 echo htmlspecialchars( implode( ",", array_keys( $expand ) ) );
353 <input type
="submit" value
="Filter">
357 <table
class="mw-profileinfo-table table table-striped table-hover">
361 echo getEscapedProfileUrl( false, 'name' );
364 echo getEscapedProfileUrl( false, 'time' );
365 ?>">Time (%
)</a
></th
>
367 echo getEscapedProfileUrl( false, 'memory' );
368 ?>">Memory (%
)</a
></th
>
370 echo getEscapedProfileUrl( false, 'count' );
373 echo getEscapedProfileUrl( false, 'calls_per_req' );
374 ?>">Calls
/req
</a
></th
>
376 echo getEscapedProfileUrl( false, 'time_per_call' );
379 echo getEscapedProfileUrl( false, 'memory_per_call' );
382 echo getEscapedProfileUrl( false, 'time_per_req' );
385 echo getEscapedProfileUrl( false, 'memory_per_req' );
391 profile_point
::$totaltime = 0.0;
392 profile_point
::$totalcount = 0;
393 profile_point
::$totalmemory = 0.0;
395 function getEscapedProfileUrl( $_filter = false, $_sort = false, $_expand = false ) {
396 // phpcs:ignore MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
397 global $filter, $sort, $expand;
399 if ( $_expand === false ) {
403 return htmlspecialchars(
406 'filter' => $_filter ?
: $filter,
407 'sort' => $_sort ?
: $sort,
408 'expand' => implode( ',', array_keys( $_expand ) )
417 /** @var profile_point|false $last */
419 foreach ( $res as $o ) {
420 $next = new profile_point( $o->pf_name
, $o->pf_count
, $o->pf_time
, $o->pf_memory
);
421 if ( $next->name() == '-total' ||
$next->name() == 'main()' ) {
422 profile_point
::$totaltime = $next->time();
423 profile_point
::$totalcount = $next->count();
424 profile_point
::$totalmemory = $next->memory();
426 if ( $last !== false ) {
427 if ( preg_match( '/^' . preg_quote( $last->name(), '/' ) . '/', $next->name() ) ) {
428 $last->add_child( $next );
433 if ( preg_match( '/^query: /', $next->name() ) ||
preg_match( '/^query-m: /', $next->name() ) ) {
434 $sqltotal +
= $next->time();
441 $s = new profile_point( 'SQL Queries', 0, $sqltotal, 0 );
442 foreach ( $queries as $q ) {
447 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
448 @usort
( $points, 'compare_point' );
450 foreach ( $points as $point ) {
451 if ( strlen( $filter ) && !strstr( $point->name(), $filter ) ) {
455 $point->display( $expand );
461 <p
>Total time
: <code
><?php
printf( '%5.02f', profile_point
::$totaltime ); ?
></code
></p
>
463 <p
>Total memory
: <code
><?php
printf( '%5.02f', profile_point
::$totalmemory / 1024 ); ?
></code
></p
>