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 bottom of :

Or set it in :

Or set in .htaccess:

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  in your : Enable more details (like a stack trace) to be shown on the "Fatal error" page. Shows a toolbar on the page with profiling, log messages and more. Adds the "log messages" part of wgDebugToolbar as a raw list to the page. MediaWiki will throw notices for some possible error conditions and for deprecated functions.

Turning display_startup_errors on
Some providers turn  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 :

Zend
If you are using the Zend PHP interpreter, you can debug your code with XDebug. MediaWiki-Vagrant has [https://git.wikimedia.org/blob/mediawiki%2Fvagrant.git/c377718dea960c5e9e7b3acc79893a5e3c14da01/puppet%2Fmodules%2Fphp%2Fmanifests%2Fremote_debug.pp#L27 built in settings] for this. If you're not using MediaWiki-Vagrant, but your setup is similar, you can reuse those values. In some cases (e.g. due to a firewall), you may have to use the IDE on the same machine as the web server. In this case, you can simply set:

If you use this configuration, you may run into an issue if HHVM is also listening on the machine. Both XDebug and HHVM use port 9000 by default. However, you can change this for XDebug (and many clients). For the XDebug side, use:

Remember if you change it for XDebug, you must also change it for your IDE.

See the [http://xdebug.org/docs/remote XDebug documentation] for more information.

To debug a command-line script (e.g. PHPUnit, or a maintenance script) on MediaWiki-Vagrant, use:

Adjust the script, parameters, and remote host (it should be the IP of the computer where your IP is, 10.0.2.2 should work for MediaWiki-Vagrant) as needed.

You may not need the sudo, depending on the script

HHVM
If you are using the HHVM PHP runtime, you can debug your code with the built in CLI debugger and debug server.

This debugger is vaguely similar to GDB.

In order for the cli debugger to attach to web requests the hhvm.debug.enable_debugger parameter needs to be enabled.

This is enabled by default on the mediawiki-vagrant development environment.

With this enabled the process is:

$ hhvm -m debug --debug-host localhost --debug-port 8089 localhost> machine list machine list 1    vagrant's default sandbox at /vagrant/www/ 2    __builtin's default sandbox at / localhost> machine attach 2 machine attach 2 Attaching to __builtin's default sandbox at / and pre-loading, please wait... localhost> break MediaWiki::run break MediaWiki::run Breakpoint 1 set upon entering MediaWiki::run localhost> continue continue

The machine attach 2 is required.

It may not always be machine 2, but it will always be the one identified as "__builtin's default sandbox at /".

This is only true on configurations that pass a  over fastcgi to hhvm (such as  and wmf production), alternate configurations may vary.

At this point the next web request that enters MediaWiki::run (all of them) will break and put you on a command prompt:

Breakpoint 1 reached at MediaWiki::run on line 450 of /vagrant/mediawiki/includes/MediaWiki.php 449           try { 450*                  $this->checkMaxLag; 451                   try { localhost>

The HHVM CLI debugger has an excellent help system, for example try help break for details on the syntax of choosing break points.

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

The instructions below are only valid for the default configuration. If you change  , for example enable the  role on a <tvar|vagrant></> box, these settings will probably be ignored.

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

The MediaWiki software must have permissions from your operating system to create and write to this file, for example in a default Ubuntu install it runs as user & group :. Here's a sample setting:

This file will contain much debug information from MediaWiki core and extensions. Some subsystems write to custom logs, see to capture their output.

dbtrans>Special:MyLanguage/Database transactions</>|Database transaction lifecycle debugging can be enabled for some databases with <tvar|debugdb></>.

Creating a custom log file
To create a custom log file that only holds your specific debug statements, use the  function. This function takes two 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 direct certain log groups to write to a separate file.

To set up custom log groups, use the following to LocalSettings.php:

To log to one of these groups, call  like this:

Structured logging
Structured logging allows you to include fields in your log records.

See <tvar|1></> for more information.

Statistics
Advanced client-side logging can be performed with Extension:EventLogging, which requires a complex setup and careful inspection of privacy issues.

Simple counting of certain kind of events is possible (since MediaWiki 1.25) using StatsD. StatsD offers meters, gauges, counters, and timing metrics.

Usage example:

The metrics can be sent to a StatsD server, which may be specified via the  configuration variable. (If not set, the metrics are discarded.) You can work with StatsD locally (without needing a Graphite server) by starting a <tvar|statsd>StatsD</> server and configuring it with the "backends/console" backend, which will output metrics to the console.

As of MediaWiki 1.25, <tvar|incrStats> </> is a shortcut for the <tvar|inc> </> method on the main  instance.

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.



Working live with MediaWiki objects
<tvar|eval></> 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

The <tvar|vagrant></> portable virtual machine integrates the interactive PHP shell  (when using the default HHVM) or   (when using Zend).

Callable updates
Code embedded in the DeferredUpdates::addCallableUpdate function, such as $rc->save in RecentChange.php, is not executed during the web request, so no error message will be displayed if it fails.

For debugging, it may be heplful to temporarily remove the code from within the function so that it is executed live.

Client side debugging
Wikipedia offers a rich set of tools for debugging client side JavaScript.

In addition to the MediaWiki tools, other techniques are available to assist with diagnosing client interactions.

Tools:


 * ResourceLoader offers a means to ensure JavaScript is easily viewable by client-side tools.

ResourceLoader/Features also describes this feature.
 * ResourceLoader also provides a safety oriented way to log to the client console. Beyond the native JavaScript logging function, it provides a check to ensure that a console is available and that logging does not produce its own error.


 * Browser tools may provide native functionality to debug client side script.


 * Network tracers, like [<tvar|url>https://www.wireshark.org/</> Wireshark] can provide insight into the script that is being provided by a page.