MDL-24600 profiling - add xhprof integration
[moodle.git] / lib / xhprof / readme_moodle.txt
CommitLineData
6af80cae
EL
1Description of XHProf 0.9.2 library/viewer import into Moodle
2
3Removed:
4 * examples - examples dir removed completely
5 * extension - extension dir removed completely
6 * package.xml - PECL package definition removed completely
7 * xhprof_html/docs - documentation dir removed completely
8
9Added:
10 * index.html - prevent directory browsing on misconfigured servers
11 * xhprof_moodle.php - containing all the stuff needed to run the xhprof profiler within Moodle
12 * readme_moodle.txt - this file ;-)
13
14Our changes: Look for "moodle" in code
15 * xhprof_html/index.php ----|
16 * xhprof_html/callgraph.php -|=> Changed to use own DB iXHProfRuns implementation (moodle_xhprofrun)
17 * xhprof_html/typeahead.php -|
18 * xhprof_html/css/xhprof.css: Minor tweaks to report styles
19 * xhprof_lib/utils/callgraph_utils.php: Modified to use $CFG->pathtodot
20
21TODO:
22 * with the 3 reports (index, callgraph and typeahead), close seesion asap,
23 so user can continue working with moodle while the report (specially
24 the graph is being generated).
25 * export/import profiling runs: Allow to pick any profile record, encapsulate
26 it into some serialized/encoded way and allow download/upload. It requires
27 DB changes in order to be able to specify the source of each record (own/imported).
28 * move profiling start to earlier place: detect if all the needed $CFG->profilingXXX variables
29 have been defined in config.php file and if that condition is fullfilled, start profiling
30 @ the very first lines of setup.php (as early as possible).
31 * improvements to the listing mode: various commodity details like:
32 - allow to filter by various criteria
33 - inline (and ajax) editing of reference/comment and deleting
34 - whatever daily usage discovers ;-)
35 * add new settings to control if we want to profile things like:
36 - php functions
37 - memory
38 - cpu times
39 (all them are right now enabled for everybody by default)
40
4120101122 - Eloy Lafuente (stronk7): Original import of 0.9.2 release