Manual:How to debug

This page gives a basic introduction to debugging MediaWiki software.

One of the first things you will notice is that "echo" generally does not work; this is part of the general design.

PHP errors
To see PHP errors, add this to the very top of LocalSettings.php: Or set it in :

This will cause PHP errors to be shown on-page. This might make it easier for attackers to find a way into your server, so disable it again when you have found the problem.

Note that fatal PHP errors may happen before the lines above are ever executed, or may prevent them from being shown. Fatal PHP errors are usually logged to Apache's error log – check the  setting in   (or use  ).

There are several configuration options to aid debugging. The following are all  by default. Enable them by setting them to  off, which hides the errors even if you raise the   level. Turning it on within the program is too late! Instead you'll have to create a wrapper file around your file. In the case of MediaWiki you can just add this on top of mediawiki/index.php:

In other environments:

SQL errors
To display SQL errors in error messages instead of "(SQL query hidden)", add the following to :

You can also enable backtrace on SQL error by setting $wgShowDBErrorBacktrace:

Logging
For much greater detail, you need to profile and log errors.

Setting up a debug log file
To save errors and debugging information to a log, add  to the   file. Change the value to a text file where you want to save the debug trace output.

This file will contain all of the built-in MediaWiki debug information.

Database transaction lifecycle debugging can be enabled for some databases with $wgDebugDBTransactions.

Creating a custom log file
To create a custom log file that only holds your specific debug statements, use the  function. This function takes 2 arguments, the text string to log and the path to the log file:

Creating custom log groups
If you're debugging several different components, it may be useful to set up log groups. To create custom log groups, add this to LocalSettings.php:

To debug to one of these groups, use a statement like this:

These logs will only contain your debug statements (not built-in MediaWiki debug information).

Send debug data to an HTML comment in the output
This may occasionally be useful when supporting a non-technical end-user. It's more secure than exposing the debug log file to the web, since the output only contains private data for the current user. But it's not ideal for development use since data is lost on fatal errors and redirects. Use on production sites is not recommended. Debug comments reveal information in page views which could potentially expose security risks.


 * Manual:$wgDebugComments

Working live with MediaWiki objects
eval.php is an interactive script to evaluate and interact with MediaWiki objects and functions in a fully initialized environment.

$ php maintenance/eval.php > print wfMessage("Recentchanges")->plain; Recent changes

Profiling
To get more detail, you need to enable 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. The generated profile only includes functions that have specifically been marked to be profiled.

If you are not using profiling, but have a  file in the MediaWiki root folder, you may receive errors referring to. Deleting, or renaming, the  file will resolve this error. The  file, also in the MediaWiki root folder, can serve as a template should you enable profiling in the future.

To enable profiling, you need to modify the  (see   in the MediaWiki root folder for an example). By default the file includes a  which just dumps profiling information. To instead direct this information to a file, edit StartProfiler.php so that it looks like this:

Then you can customize profiling options in  (not  ; be sure to edit beneath the requirement of  ).

Common configuration (both <1.7 and >1.8):

In MediaWiki 1.7 and earlier, instead of editing, you have to set   to. This will generate basic page timing information in the file defined by.

In addition to the settings list above, these additional settings are available:

Advanced profiling
Once you have enabled profiling, you can trace code execution through any function that you want to investigate as a bottleneck by wrapping the function with the following code:

After you've added this information, browse to a page in the wiki. This will generate profiling info in the log file you defined above. Change  in   to true or false for different display formats.

Logging to Database
To log profiling information to a database, set  in LocalSettings.php. Then either run update.php (since 1.21) and the profiling table will be added or manually apply the file maintenance/archives/patch-profiling.sql (the recommended way to do this is ).

Viewing Profile Info
If you log your profiling information to the database, you can view the information in a webpage by browsing to. You must also set in. Then, after gathering data by browsing wiki pages, visit  to see how much time your profiled code is using and how many times it's being called.

To view profiling information as HTML comments appended to the bottom of a page, just add  to the URL. This feature is not in the standard product, you can enable it by adding this to :