Manual:Profiling

Profiling tracks code execution during a page action and reports back the percentage of total code execution that was spent in any specific function. Profiling is an advanced task intended for developers and system administrators to track sources of slowness in MediaWiki that should be optimized.

PHP profiling
You can use Tideways for PHP 7, or XHProf, for PHP 5. These PHP extensions provide tracing and profiling capabilities.

Tideways also advertises a proprietary UI to visualize results, but you don't need that.

Install the   package on Debian/Ubuntu, or Homebrew on macOS.

MediaWiki custom profiler
In MediaWiki 1.25 profiling was completely rewritten and many settings previous relating to profiling were removed in favor of consolidating them as parameters to $wgProfiler. Notably, output has been separated from class types. For documentation about profiling prior to 1.25, see an 1>Special:Permalink/1281616|older version of this page.

Example $wgProfiler configuration:

Each of these parameters (and more) are described in detail:


 * class
 * 'ProfilerXhprof'. ProfilerXhprof is new in MediaWiki 1.25 and provides an Xhprof-backed profiler that captures profiling data for all functions as well as sub-functional units. Old values such as ProfilerStandard, ProfilerUDP, ProfilerDB, etc do not work.  Even if you are using Tideways, still specify the ProfilerXhprof class.


 * output
 * One or more of 'ProfilerOutputText', 'ProfilerOutputDump', 'ProfilerOutputStats' . Text outputs the information in either HTML comments or after the skin.  UDP is a format send to a udpprofile daemon.  Dump produces a dump of the profiling info for use with xhprof GUI (xhprofgui role on 1>Special:MyLanguage/MediaWiki-Vagrant#Using_roles|Vagrant setup).


 * outputDir
 * Only applies to 'ProfilerOutputDump' format. Required to specify where the dump files will be stored.


 * visible
 * Only applies to <tvar|1>'ProfilerOutputText'</> format. Whether text is shown after the skin or in an HTML comment.

Troubleshooting
If you get "Fatal error: Uncaught Exception: Neither xhprof nor tideways are installed" then you need to do:

If the package can't be found then take a look at https://tideways.com/profiler/xhprof-for-php7

Output
Text output looks like:

The first column is the time percent; the second column is the time>Special:MyLanguage/Manual:Profiling table#pf_time</>|time (in ms); the third column is the count>Special:MyLanguage/Manual:Profiling table#pf_count</>|count; and the fourth column is the name>Special:MyLanguage/Manual:Profiling table#pf_name</>|name of the method.