Merge "Removed obsolete "containsOldMagic" code"
[lhc/web/wiklou.git] / StartProfiler.sample
1 <?php
2
3 /**
4 * To use a profiler, copy this file to StartProfiler.php and add:
5 * $wgProfiler['class'] = 'ProfilerXhprof';
6 *
7 * For output, add:
8 * $wgProfiler['output'] = array( 'text' );
9 * 'text' can be one (or more) of 'text' 'udp' 'db' or 'dump'
10 * 'db' requires creating the profiling table, see patch-profiling.sql
11 *
12 * The 'text' output will be added to the output page in a comment approriate
13 * to the output's mime type. For a text/html page, this display can be
14 * changed to a preformatted text block by setting the 'visible' configuration
15 * flag:
16 * $wgProfiler['visible'] = true;
17 *
18 * The 'db' output expects a database table that can be created by applying
19 * maintenance/archives/patch-profiling.sql to your database.
20 *
21 * The 'dump' output expects a $wgProfiler['outputDir'] telling it where to
22 * write dump files. The files produced are compatible with the XHProf gui.
23 *
24 * For a rudimentary sampling profiler:
25 * $wgProfiler['class'] = 'ProfilerXhprof';
26 * $wgProfiler['output'] = array( 'db' );
27 * $wgProfiler['sampling'] = 50; // one every 50 requests
28 * This will use ProfilerStub for non-sampled cases.
29 *
30 * For performance, the profiler is always disabled for CLI scripts
31 * as they could be long running and the data would accumulate. Use
32 * the --profiler parameter of maintenance scripts to override this.
33 */