Manual:$wgProfiler

Profiling: $wgProfiler
Settings related to profiling.
Introduced in version:	1.8.0
Removed in version:	Still in use
Allowed values:	(associative array)
Default value:	[]
Other settings: Alphabetical | By function

Details

This setting is used to configure profiling of your MediaWiki installation.

For the available keys see Manual:Profiling . They include:

'class'

E.g. ProfilerXhprof provides an Xhprof-backed profiler. There is also ProfilerExcimer which works with Excimer .

'output'

Define one or multiple output methods. For multiple output methods at the same time, use an array of class names, one for each output type you want the profiler to generate. For example use the "ProfilerOutputText" profiler. The output classes available to you by default are: ProfilerOutputDump, ProfilerOutputStats, ProfilerOutputText.

• ProfilerOutputStats outputs profiling data as StatsD metrics. It expects that you have set the $wgStatsdServer configuration variable to the host (or host:port) of your statsd server.
• ProfilerOutputText will output profiling data in the page body as a comment. You can make the profiling data in HTML render as part of the page content by setting the 'visible' configuration flag: $wgProfiler['visible'] = true;
• ProfilerOutputDump expects a $wgProfiler['outputDir'] telling it where to write dump files. The files produced are compatible with the XHProf gui.

'visible'

true or false. If true, output is displayed in HTML rendering (and not only in a comment).

'sampling'

Positive integer. Profile every n^th request.

For performance, the profiler is always disabled for CLI scripts as they could be long running and the data would accumulate. Use the '--profiler' parameter of maintenance scripts to override this.

Example

For a rudimentary debug profiler:

$wgProfiler= [
  'class' => ProfilerXhprof::class,
  'output' => ProfilerOutputText::class,
];

See also

• Manual:Profiling