Profiling PHP - Revision history

Devdocsbot: Protected "Profiling PHP": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2023-05-22T00:44:03Z

Protected "Profiling PHP": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 00:44, 22 May 2023
(No difference)

Devdocsbot: Update migration status and path

2023-05-22T00:41:54Z

Update migration status and path

Show changes

Mkwasnic: Struck through dead hyperlinks

2021-12-27T15:53:18Z

Struck through dead hyperlinks

← Older revision		Revision as of 15:53, 27 December 2021
Line 131:		Line 131:
	* [http://moodle.org/mod/forum/discuss.php?d=162045 Forum thread about profiling Moodle 2.0]		* [http://moodle.org/mod/forum/discuss.php?d=162045 Forum thread about profiling Moodle 2.0]
	XHProf articles:		XHProf articles:
	* [https://docs.google.com/present/view?id=dcbkgbgf_45fbg3rnmk& Presentation about XHProf]		* [https://docs.google.com/present/view?id=dcbkgbgf_45fbg3rnmk& <s>Presentation about XHProf</s>]
	* [http://techportal.ibuildings.com/2009/12/01/profiling-with-xhprof/ Profiling with XHProf]		* [http://techportal.ibuildings.com/2009/12/01/profiling-with-xhprof/ <s>Profiling with XHProf</s>]
	* [http://www.open.ac.uk/blogs/XHProf/?page_id=46 XHProf – Profiling and Reporting] from Moodle perspective written by [http://moodle.org/user/view.php?id=264538&course=5 James Brisland]		* [http://www.open.ac.uk/blogs/XHProf/?page_id=46 <s>XHProf – Profiling and Reporting</s>] from Moodle perspective written by [http://moodle.org/user/view.php?id=264538&course=5 James Brisland]
	Xdebug articles:		Xdebug articles:
	* [http://devzone.zend.com/article/2803-Introducing-xdebug Introducing xdebug]		* [http://devzone.zend.com/article/2803-Introducing-xdebug Introducing xdebug]
	* [http://blog.teamlazerbeez.com/2010/05/04/xdebug-quickstart-profiling-in-php/ Xdebug Quickstart: Profiling in PHP]		* [http://blog.teamlazerbeez.com/2010/05/04/xdebug-quickstart-profiling-in-php/ Xdebug Quickstart: Profiling in PHP]

Dongsheng at 13:18, 11 August 2021

2021-08-11T13:18:19Z

← Older revision		Revision as of 13:18, 11 August 2021
Line 107:		Line 107:
	===Quick summary===		===Quick summary===

	1. Install ~~XDebug~~ extension on your server.		1. Install Xdebug 3 extension on your server.

	2. Add something like this to your php.ini file:		2. Add something like this to your php.ini file:
	zend_extension = /usr/lib/~~php5~~/~~20090626~~/xdebug.so		zend_extension = /usr/local/lib/php/pecl/20190902/xdebug.so
	xdebug.~~profiler_enable~~ = 0		xdebug.mode = profile
	xdebug.~~profiler_enable_trigger~~ = 1		xdebug.start_with_request = trigger
	xdebug.~~profiler_output_dir~~ = /var/tmp		xdebug.output_dir = /var/tmp
	xdebug.profiler_output_name = cachegrind.out.%R.%t		xdebug.profiler_output_name = cachegrind.out.%R.%t
	or add something like this to your .htaccess file		or add something like this to your .htaccess file
	php_flag xdebug.~~profiler_enable off~~		php_flag xdebug.mode = profile
	php_flag xdebug.~~profiler_enable_trigger on~~		php_flag xdebug.start_with_request = trigger
	php_value xdebug.~~profiler_output_dir~~ /var/tmp		php_value xdebug.output_dir /var/tmp
	php_value xdebug.profiler_output_name cachegrind.out.%R.%t		php_value xdebug.profiler_output_name cachegrind.out.%R.%t

Timhunt: /* Tideways (replacement for XHProf) */

2020-02-13T12:03:44Z

Tideways (replacement for XHProf)

← Older revision		Revision as of 12:03, 13 February 2020
Line 5:		Line 5:
	==Tideways (replacement for XHProf)==		==Tideways (replacement for XHProf)==

	[https://tideways.com/profiler/downloads Tideways] is a PHP7-compatible replacement for XHProf, and support for this is built into Moodle. ([https://tideways.io/ Tideways] is a large, paid-for service, which helps to identify a range of issues with production servers. Whilst the service itself is a paid-for service, the instrumentation tooling is both Open Source, and free.) When the XHProf PHP extension is installed, the "Profiling" section is displayed in "Site administration / Development". And when the profiling setting (profilingenabled) is enabled, a new link "Profiling runs" is also displayed in the Development tab. From this section, apart from access to the profiling runs, you can also import .mpr (Moodle profiling) files.		[https://tideways.com/profiler/downloads Tideways] is a PHP7-compatible replacement for XHProf, and support for this is built into Moodle. ([https://tideways.io/ Tideways] is a large, paid-for service, which helps to identify a range of issues with production servers. Whilst the service itself is a paid-for service, the instrumentation tooling is both Open Source, and free.)

			When the XHProf PHP extension is installed, the "Profiling" section is displayed in "Site administration / Development". And when the profiling setting (profilingenabled) is enabled, a new link "Profiling runs" is also displayed in the Development tab. From this section, apart from access to the profiling runs, you can also import .mpr (Moodle profiling) files.

	There are two variants of the plugin. You will almost certainly want the tideways_xhprof plugin.		There are two variants of the plugin. You will almost certainly want the tideways_xhprof plugin.

Sarjona: Improvements to add reference to Moodle profiling sections in the Development tab

2020-02-04T09:19:20Z

Improvements to add reference to Moodle profiling sections in the Development tab

← Older revision		Revision as of 09:19, 4 February 2020
Line 5:		Line 5:
	==Tideways (replacement for XHProf)==		==Tideways (replacement for XHProf)==

	[https://tideways.com/profiler/downloads Tideways] is a PHP7-compatible replacement for XHProf, and support for this is built into Moodle. ([https://tideways.io/ Tideways] is a large, paid-for service, which helps to identify a range of issues with production servers. Whilst the service itself is a paid-for service, the instrumentation tooling is both Open Source, and free.)		[https://tideways.com/profiler/downloads Tideways] is a PHP7-compatible replacement for XHProf, and support for this is built into Moodle. ([https://tideways.io/ Tideways] is a large, paid-for service, which helps to identify a range of issues with production servers. Whilst the service itself is a paid-for service, the instrumentation tooling is both Open Source, and free.) When the XHProf PHP extension is installed, the "Profiling" section is displayed in "Site administration / Development". And when the profiling setting (profilingenabled) is enabled, a new link "Profiling runs" is also displayed in the Development tab. From this section, apart from access to the profiling runs, you can also import .mpr (Moodle profiling) files.

	There are two variants of the plugin. You will almost certainly want the tideways_xhprof plugin.		There are two variants of the plugin. You will almost certainly want the tideways_xhprof plugin.

Timhunt at 15:28, 2 September 2019

2019-09-02T15:28:45Z

← Older revision		Revision as of 15:28, 2 September 2019
Line 3:		Line 3:
	* [http://www.xdebug.org/docs/profiler XDebug] is well known. and understood, and its trace output is supported by tools like [http://kcachegrind.sourceforge.net/html/Home.html KCachegrind]. It is not recommended for production environments.		* [http://www.xdebug.org/docs/profiler XDebug] is well known. and understood, and its trace output is supported by tools like [http://kcachegrind.sourceforge.net/html/Home.html KCachegrind]. It is not recommended for production environments.

	==XHProf==		==Tideways (replacement for XHProf)==

	~~The original XHProf project~~ is ~~no longer supported with~~ PHP7, ~~but several alternative tools are freely available~~ and ~~generate compatible profiling information.~~		[https://tideways.com/profiler/downloads Tideways] is a PHP7-compatible replacement for XHProf, and support for this is built into Moodle. ([https://tideways.io/ Tideways] is a large, paid-for service, which helps to identify a range of issues with production servers. Whilst the service itself is a paid-for service, the instrumentation tooling is both Open Source, and free.)
	~~The most widely used of these~~ is ~~Tideways, which~~ Moodle ~~supports~~.

	[https://tideways.io/ Tideways] is a large, paid-for service, which helps to identify a range of issues with production servers.
	Whilst the service itself is a paid-for service, the instrumentation tooling is both Open Source, and free.

	There are two variants of the plugin. You will almost certainly want the tideways_xhprof plugin.		There are two variants of the plugin. You will almost certainly want the tideways_xhprof plugin.

Andrewnicols: Update for tideways_xhprof and to remove xhprof (PHP5 only)

2018-11-20T05:32:21Z

Update for tideways_xhprof and to remove xhprof (PHP5 only)

@@ Line 1: / Line 1: @@
-PHP has two significant profilers. One is [http://www.xdebug.org/docs/profiler XDebug]. XDebug is well known and understood and its trace output is supported by tools like [http://kcachegrind.sourceforge.net/html/Home.html KCachegrind]. The other is [http://pecl.php.net/package/xhprof xhprof], a profiler released by facebook's engineering team, designed for capturing profile traces on live servers.
+PHP has two types of profiler:
 ==XHProf==
-NOTE: xhprof is not supported with php7, for a feature identical solution see Tideways below.
+The original XHProf project is no longer supported with PHP7, but several alternative tools are freely available and generate compatible profiling information.
-XHProf aims to have the minimum impact on execution times and require relatively little space to store a trace, so you can run it live without a noticeable impact on users and without filling disks. The trade off with XHProf is in ''slightly'' less detail and a trace format that needs its own GUI to visualize (which ships with XHProf). The reason you'd want to profile in a live environments (vs. on development) is certain categories of problem may only been seen live, e.g. (data related) what happens when the user table grows 100 times, the impact on "login.php"  or (service related) server to server HTTP requests.
+[https://tideways.io/ Tideways] is a large, paid-for service, which helps to identify a range of issues with production servers.
 See
@@ Line 11: / Line 30: @@
 * http://tjhunt.blogspot.co.uk/2013/05/performance-testing-moodle.html
 * https://docs.google.com/presentation/d/1MV4R71UBgPgzM6I9h_yDnYcxIJlgCoLBUDtJJr-TzNI/present#slide=id.i0 presentation about using XHProf
 === Export Xhprof data to plugins ===

Prg3 at 20:19, 20 August 2018

2018-08-20T20:19:41Z

← Older revision		Revision as of 20:19, 20 August 2018
Line 13:		Line 13:


	== Tideways for php7 ==		=== Tideways for php7 ===

	xhprof isn't supported for php7, but there is an alternative project called Tideways which is almost binary compatible. Moodle now supports Tideways as well see (MDL-55292)[https://tracker.moodle.org/browse/MDL-55292]		xhprof isn't supported for php7, but there is an alternative project called Tideways which is almost binary compatible. Moodle now supports Tideways as well see (MDL-55292)[https://tracker.moodle.org/browse/MDL-55292]
Line 24:		Line 24:


			=== Export Xhprof data to plugins ===

			Starting at 3.6, Moodle allows for a plugin to handle the Xhprof data and not insert the traces into the database as implemented in (MDL-63031)[https://tracker.moodle.org/browse/MDL-63031]

			To disable Moodle from writing traces to the database, add: "$CFG->disableprofilingtodatabase = False;" into config.php

			Plugins will need to provide a _store_profiling_data function to handle the data.

	==Xdebug==		==Xdebug==

Prg3: /* Analyzing Xdebug profiling files */

2018-08-20T20:04:22Z

Analyzing Xdebug profiling files

← Older revision		Revision as of 20:04, 20 August 2018
Line 92:		Line 92:
	===Analyzing Xdebug profiling files===		===Analyzing Xdebug profiling files===

	As it was pointed out earlier, profiling data is recoded in cachegrind format, so it can be analysed using one of external tools, such as [~~http~~://kcachegrind.~~sourceforge~~.~~net~~/html/Home.html KCachegrind], [http://sourceforge.net/projects/wincachegrind/ WinCacheGrind], [http://code.google.com/p/xdebugtoolkit/ xdebugtoolkit] or web-based analyser [https://github.com/jokkedk/webgrind#readme Webgrind]. Using these tools is pretty simple. I prefer KCachegrind which has a feature to show the matching code if web-server is run on the same box. Xdebug profiler documentation page has a [http://xdebug.org/docs/profiler#misc section] about KCachegrind that worth reading for everyone who starts using KCachegrind.		As it was pointed out earlier, profiling data is recoded in cachegrind format, so it can be analysed using one of external tools, such as [https://kcachegrind.github.io/html/Home.html KCachegrind], [http://sourceforge.net/projects/wincachegrind/ WinCacheGrind], [http://code.google.com/p/xdebugtoolkit/ xdebugtoolkit] or web-based analyser [https://github.com/jokkedk/webgrind#readme Webgrind]. Using these tools is pretty simple. I prefer KCachegrind which has a feature to show the matching code if web-server is run on the same box. Xdebug profiler documentation page has a [http://xdebug.org/docs/profiler#misc section] about KCachegrind that worth reading for everyone who starts using KCachegrind.

	===Quick summary===		===Quick summary===