このページでは、MediaWiki をデバッグするソフトウェアの基礎を紹介します。

最初に気付くことの 1 つは、"echo" が全般的に動作しないということでしょう。この挙動は全般的な設計の一部です。

デバッグを支援するための設定オプションがいくつかあります。以下は、既定ではすべて false に設定されています。 LocalSettings.php で true に設定することで有効にできます。

• $wgShowExceptionDetails 「致命的なエラー」ページにスタック トレースなどの詳細情報を表示できるようにします。
• $wgDebugToolbar ページ上にプロファイリング、ログ メッセージなどを含むツールバーを表示します。
• $wgShowDebug ログ メッセージをページの下部に生のリストとして追加します。
• $wgDevelopmentWarnings MediaWiki は、いくつかの潜在的なエラー状況や廃止予定の関数に対して通知を出します。

LocalSettings.php に追加する例は以下の通りです:

$wgShowExceptionDetails = true;

PHP のエラー

PHP のエラーを閲覧するには、LocalSettings.php の2行目の先頭 (<?php の直下) に以下を追加します:

error_reporting( -1 );
ini_set( 'display_errors', 1 );

または php.ini 内で設定します:

error_reporting = E_ALL
display_errors = On

あるいは .htaccess 内で設定します:

php_value error_reporting -1
php_flag display_errors On

これにより PHP エラーがページ上に表示されるようになります。ただし、攻撃者がサーバーへの侵入方法を見つけやすくなる可能性があるため、問題を特定したら再び無効にしてください。

なお、致命的な PHP エラーは、上記の行が実行される前に発生する場合や、表示を妨げる場合があることにご注意ください。 致命的な PHP エラーは通常 Apache のエラーログに記録されます。php.ini 内の error_log 設定を確認するか、phpinfo() を使用してください。

--- index.php
    error_reporting( -1 );
    ini_set( 'display_startup_errors', 1 );
    ini_set( 'display_errors', 1 );

--- myTestFile.php
    error_reporting( -1 );
    ini_set( 'display_startup_errors', 1 );
    ini_set( 'display_errors', 1 );
    require 'your_file.php';

SQLのエラー

例外を引き起こしたものだけでなく、すべての SQL クエリを記録するには、LocalSettings.php 内で $wgDebugDumpSql を設定してください:

$wgDebugDumpSql = true;

詳細なデバッグ

xdebug.remote_enable = 1
xdebug.remote_host = 'localhost'

xdebug_on; php /vagrant/mediawiki/path/to/script.php --wiki=wiki ; xdebug_off

ログ作成

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

The instructions below are only valid for the default configuration. If you change $wgMWLoggerDefaultSpi , for example to enable the psr3 role on a vagrant box, these settings will probably be ignored. In this case, see the documentation of your logger, for example, Manual:MonologSpi .

デバッグ ログ ファイルのセットアップ

To save errors and debugging information to a log, add $wgDebugLogFile to the LocalSettings.php 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 www-data:www-data. これは設定例です。

/**
 * The debug log file must never be publicly accessible because it contains private data.
 * But ensure that the directory is writeable by the PHP script running within your Web server.
 * The filename is with the database name of the wiki.
 */
$wgDebugLogFile = "/var/log/mediawiki/debug-{$wgDBname}.log";

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

警告:

The debug log file can contain private information such as login credentials, session cookies, and values of submitted forms. If this information is publicly accessible, attackers can use it to hack and compromise your machine and user account. If you need to share a debug log for diagnostic purposes, access the wiki without being logged in, and remove from the debug log any COOKIE lines, and don't capture any login attempt.

カスタムロググループの作成

If you're debugging several different components, it may be useful to direct certain log groups to write to a separate file. 詳細情報は $wgDebugLogGroups を参照してください。

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

/**
 * The debug log file should not be publicly accessible if it is used, as it
 * may contain private data. However, it must be in a directory to which PHP run
 * within your web server can write.
 *
 * Contrary to wgDebugLogFile, it is not necessary to include a wiki-id in these log file names
 * if you have multiple wikis. These log entries are prefixed with sufficient information to
 * identify the relevant wiki (web server hostname and wiki-id).
 */

// Groups from MediaWiki core
$wgDBerrorLog = '/var/log/mediawiki/dberror.log';
$wgDebugLogGroups = [
	'exception' => '/var/log/mediawiki/exception.log',
	'resourceloader' => '/var/log/mediawiki/resourceloader.log',
	'ratelimit' => '/var/log/mediawiki/ratelimit.log',

	// Extra log groups from your extension
	#'myextension' => '/var/log/mediawiki/myextension.log',
	#'somegroup' => '/var/log/mediawiki/somegroup.log',
];

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

if ( $module->hasFailed ) {
    wfDebugLog( 'myextension', "Something is not right, module {$module->name} failed." );
}

If you have carefully followed the instructions above but nothing gets written to your logging file(s), and if your system is using SELinux, have a look at the logging section on the SELinux page to get around this SELinux context issue.

Writing log files to the /tmp directory may not generate any log file at all, even if the /tmp directory is supposed to be writable by anyone. This could happen if your system is using one of the systemd features that create a virtual /tmp directory for that process. If that's the case, configure your log file to be written into a different directory, like /var/log/mediawiki

構成した記録

MediaWiki バージョン:

≧ 1.25

構成した記録によりログにフィールドを追加できます。 詳細情報は Structured logging を参照してください。

You will need to configure a better logger to collect the extra fields, for example Monolog.

JavaScriptエラーの記録

MediaWiki バージョン:

≧ 1.36

See the documentation of the mediawiki.errorLogger ResourceLoader module.

$stats = $context->getStats();
$stats->increment( 'resourceloader.cache.hits' );
$stats->timing( 'resourceloader.cache.rtt', $rtt );

$wgDebugComments = true;

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

クライアント側のデバッグ (JavaScript)

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.

ツール:

• ブラウザのコンソールを開く Many client side mediawiki scripts log error messages to the console using ResourceLoader, which 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. ResourceLoader/Architecture#Debug_mode also describes this feature.

関連項目

• Manual:デバッグの方法/ログインの問題点
• Manual:Profiling
• ResourceLoader: ResourceLoader/Developing with ResourceLoader#Debugging
• デバッグ・ログ取得に関わるすべての構成変数: Manual:構成設定#デバッグ・ログ取得
• デバッグに使えるヒント: throw new MWException( 'foo' ); (特定のメッセージにより解除しコールスタックを出力)
• Manual:Errors and symptoms
• Category:Debug variables
• wikitech:Debugging in production - Debugging on Wikimedia's production cluster
• Help:壊れたスクリプトを特定する