View source for Manual:How to debug/ru

<languages/>
{{TOC|align|right}}
На этой странице предствлено базовое введение в '''отладку ПО MediaWiki'''.

<div lang="en" dir="ltr" class="mw-content-ltr">
One of the first things you will notice is that "echo" generally does not work; this is part of the general design.
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">There are several configuration options to aid debugging. The following are all <code>false</code> by default.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Enable them by setting them to <code>true</code> in your {{ll|Manual:LocalSettings.php|LocalSettings.php}}:</span>

* {{wg|ShowExceptionDetails}} <span lang="en" dir="ltr" class="mw-content-ltr">Enable more details (like a stack trace) to be shown on the "Fatal error" page.</span>
* {{wg|DebugToolbar}} <span lang="en" dir="ltr" class="mw-content-ltr">Shows a toolbar on the page with profiling, log messages and more.</span>
* {{wg|ShowDebug}} <span lang="en" dir="ltr" class="mw-content-ltr">Adds the "log messages" part of wgDebugToolbar as a raw list to the page.</span>
* {{wg|DevelopmentWarnings}} <span lang="en" dir="ltr" class="mw-content-ltr">MediaWiki will throw notices for some possible error conditions and for deprecated functions.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Example line to be added in your {{ll|Manual:LocalSettings.php|LocalSettings.php}}:
</div>

<syntaxhighlight lang="php">
$wgShowExceptionDetails = true;
</syntaxhighlight>

<span id="PHP_errors"></span>
== PHP-ошибки ==

Чтобы увидеть PHP-ошибки, добавьте следующее ко второй строке сверху в {{ll|Manual:LocalSettings.php|LocalSettings.php}} (прямо под {{phpi|<?php}}):

<syntaxhighlight lang="php">
error_reporting( -1 );
ini_set( 'display_errors', 1 );
</syntaxhighlight>

Или укажите в {{ll|Manual:php.ini|php.ini}}:

<syntaxhighlight lang="ini">
error_reporting = E_ALL
display_errors = On
</syntaxhighlight>

Или укажите в .htaccess:

<syntaxhighlight lang="apache">
php_value error_reporting -1
php_flag display_errors On
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">Note that ''fatal'' PHP errors may happen before the lines above are ever executed, or may prevent them from being shown.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Fatal PHP errors are usually logged to Apache's error log – check the <code>[https://php.net/error_log error_log]</code> setting in <code>php.ini</code> (or use <code>[https://php.net/phpinfo phpinfo()]</code>).</span>

<span id="Turning_display_startup_errors_on"></span>
=== Активация отображения ошибок при запуске (display_startup_errors) ===
<span lang="en" dir="ltr" class="mw-content-ltr">Some providers turn <code>display_startup_errors</code> off, which hides the errors even if you raise the <code>error_reporting</code> level.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Turning it on within the program is too late! Instead you'll have to create a wrapper file around your file.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In the case of MediaWiki you can just add this on top of mediawiki/index.php:</span>

<syntaxhighlight lang="php">
--- index.php
    error_reporting( -1 );
    ini_set( 'display_startup_errors', 1 );
    ini_set( 'display_errors', 1 );
</syntaxhighlight>

В других окружениях:

<syntaxhighlight lang="php">
--- myTestFile.php
    error_reporting( -1 );
    ini_set( 'display_startup_errors', 1 );
    ini_set( 'display_errors', 1 );
    require 'your_file.php';
</syntaxhighlight>

<span id="SQL_errors"></span>
== SQL-ошибки ==

<div lang="en" dir="ltr" class="mw-content-ltr">
To log all SQL queries, rather than just the one that raised the exception, set {{manual|$wgDebugDumpSql}} in <code>LocalSettings.php</code>:
</div>

<syntaxhighlight lang="php">
$wgDebugDumpSql = true;
</syntaxhighlight>

{{MW version|version=1.16|version2=1.31}}
<div lang="en" dir="ltr" class="mw-content-ltr">
Prior to MediaWiki 1.32, you needed to set {{manual|$wgShowSQLErrors}} and {{manual|$wgShowDBErrorBacktrace}} to see details of database exceptions in the HTML output:
</div>

<syntaxhighlight lang="php">
$wgShowSQLErrors = true;
$wgShowDBErrorBacktrace = true;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
==In-depth debugging==
</div>

<span id="Debugger"></span>
=== Отладчик ===

<div lang="en" dir="ltr" class="mw-content-ltr">
You can debug your code step-by-step with {{ll|XDebug}}. For some common setups, see:
</div>

* [[MediaWiki-Docker/Configuration recipes/Xdebug|MediaWiki-Docker]]
* [[Cli/guide/Docker-Development-Environment/MediaWiki#XDebug|mwcli]]
* [[Manual:How to debug/with MediaWiki-Vagrant and PHPStorm|Vagrant with PHPStorm]]
* [[MediaWiki-Vagrant/Advanced_usage#MediaWiki_debugging_using_Xdebug_and_an_IDE_in_your_host|Vagrant with other IDEs]]
* [[Manual:Running_MediaWiki_on_macOS#Setting_up_XDebug_with_PhpStorm|MacOS]]

<span lang="en" dir="ltr" class="mw-content-ltr">MediaWiki-Vagrant has [https://phabricator.wikimedia.org/diffusion/MWVA/browse/master/puppet/modules/php/manifests/remote_debug.pp;c377718dea960c5e9e7b3acc79893a5e3c14da01$27 built in settings] for this.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If you're not using MediaWiki-Vagrant, but your setup is similar, you can reuse those values.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In some cases (e.g. due to a firewall), you may have to use the IDE on the same machine as the web server.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In this case, simply set:</span>

<syntaxhighlight lang="ini">
xdebug.remote_enable = 1
xdebug.remote_host = 'localhost'
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
See the [https://xdebug.org/docs/remote XDebug documentation] for more information.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To debug a command-line script (e.g. PHPUnit, or a maintenance script) on MediaWiki-Vagrant, use:
</div>

<syntaxhighlight lang="php">
xdebug_on; php /vagrant/mediawiki/path/to/script.php --wiki=wiki ; xdebug_off
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>

<span id="Logging"></span>
=== Журналирование ===

<div lang="en" dir="ltr" class="mw-content-ltr">
For much greater detail, you need to profile and log errors.
</div> 

{{Note|1=<span lang="en" dir="ltr" class="mw-content-ltr">The instructions below are only valid for the default configuration.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If you change <code>{{ll|Manual:$wgMWLoggerDefaultSpi|$wgMWLoggerDefaultSpi}}</code>, for example to enable the <code>psr3</code> role on a {{ll|MediaWiki-Vagrant|vagrant}} box, these settings will probably be ignored.</span> <span lang="en" dir="ltr" class="mw-content-ltr">In this case, see the documentation of your logger, for example, {{ll|Manual:MonologSpi}}.</span>}}

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Setting up a debug log file ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To save errors and debugging information to a log, add <code>{{ll|Manual:$wgDebugLogFile|$wgDebugLogFile}}</code> to the <code>LocalSettings.php</code> file. Change the value to a text file where you want to save the debug trace output.
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">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 <code>www-data</code>:<code>www-data</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Here's a sample setting:</span>

<syntaxhighlight lang="php">
/**
 * 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";
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">This file will contain much debug information from MediaWiki core and extensions.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Some subsystems write to custom logs, see [[#Creating a custom log file|#Creating a custom log file]] to capture their output.</span>


{{warning|1=<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>}}

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Creating a custom log file ====
</div>
{{MW 1.31|and before}}
<span lang="en" dir="ltr" class="mw-content-ltr">Prior to MediaWiki 1.32, to create a custom log file that only holds your specific debug statements, use the <code>wfErrorLog()</code> function.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This function takes two arguments, the text string to log and the path to the log file:</span>

<syntaxhighlight lang="php">
wfErrorLog( "An error occurred.\n", '/var/log/mediawiki/my-custom-debug.log' );
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Creating custom log groups ====
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">If you're debugging several different components, it may be useful to direct certain log groups to write to a separate file.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">See {{ll|Manual:$wgDebugLogGroups|$wgDebugLogGroups}} for more information.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
To set up custom log groups, use the following to LocalSettings.php:
</div>

<syntaxhighlight lang="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 = array(
	'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',
);
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
To log to one of these groups, call <code>wfDebugLog</code> like this:
</div>

<syntaxhighlight lang="php">
if ( $module->hasFailed ) {
    wfDebugLog( 'myextension', "Something is not right, module {$module->name} failed." );
}
</syntaxhighlight>

{{Tip|1=<span lang="en" dir="ltr" class="mw-content-ltr">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 [[Special:MyLanguage/SELinux#Debug_logging_file|logging section on the SELinux page]] to get around this SELinux context issue.</span>}}

{{Tip|1=<span lang="en" dir="ltr" class="mw-content-ltr">Writing log files to the <code>/tmp</code> directory may not generate any log file at all, even if the /tmp directory is supposed to be writable by anyone.</span> <span lang="en" dir="ltr" class="mw-content-ltr">This could happen if your system is using one of the systemd features that create a virtual /tmp directory for that process.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If that's the case, configure your log file to be written into a different directory, like <code>/var/log/mediawiki</code></span>}}

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Structured logging ====
</div>
{{MW 1.25|and after}}
<span lang="en" dir="ltr" class="mw-content-ltr">Structured logging allows you to include fields in your log records.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">See {{ll|Structured logging}} for more information.</span>

{{Note|1=<span lang="en" dir="ltr" class="mw-content-ltr">You will need to configure a better logger to collect the extra fields, for example Monolog.</span>}}

<div lang="en" dir="ltr" class="mw-content-ltr">
==== JavaScript error logging ====
</div>
{{MW 1.36|and after}}
<span lang="en" dir="ltr" class="mw-content-ltr">See the documentation of the {{ll|ResourceLoader/Core modules#mediawiki.errorLogger|mediawiki.errorLogger}} ResourceLoader module.</span>

<span id="Statistics"></span>
=== Статистика ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Advanced client-side logging can be performed with {{ll|Extension:EventLogging}}, which requires a complex setup and careful inspection of privacy issues.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Simple counting of certain kind of events is possible (since MediaWiki 1.25) using [https://github.com/etsy/statsd StatsD]. StatsD offers meters, gauges, counters, and timing metrics.
</div>

Пример использования:

<syntaxhighlight lang="php">
$stats = $context->getStats();
$stats->increment( 'resourceloader.cache.hits' );
$stats->timing( 'resourceloader.cache.rtt', $rtt );
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">The metrics can be sent to a StatsD server, which may be specified via the <code>wgStatsdServer</code> configuration variable.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">(If not set, the metrics are discarded.)</span>
<span lang="en" dir="ltr" class="mw-content-ltr">You can work with StatsD locally (without needing a Graphite server) by starting a [https://github.com/etsy/statsd StatsD] server and configuring it with the "backends/console" backend, which will output metrics to the console.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
As of MediaWiki 1.25, <code>wfIncrStats()</code> is a shortcut for the <code>increment()</code> method on the main <code>RequestContext::getStats()</code> instance.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Send debug data to an HTML comment in the output ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>

<syntaxhighlight lang="php">
$wgDebugComments = true;
</syntaxhighlight>

* {{ll|Manual:$wgDebugComments|$wgDebugComments}}

<div lang="en" dir="ltr" class="mw-content-ltr">
===Working live with MediaWiki objects===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{{ll|Manual:Eval.php|eval.php}} is an interactive script to evaluate and interact with MediaWiki objects and functions in a fully initialized environment.
</div>

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

<div lang="en" dir="ltr" class="mw-content-ltr">
The {{ll|MediaWiki-Vagrant}} portable virtual machine integrates the interactive PHP shell <code>phpsh</code> (when using Zend).
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
===Callable updates===
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Code embedded in the <code>DeferredUpdates::addCallableUpdate()</code> function, such as <code>$rc->save()</code> in <code>RecentChange.php</code>, is not executed during the web request, so no error message will be displayed if it fails.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For debugging, it may be helpful to temporarily remove the code from within the function so that it is executed live.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
===Interactive shell===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You can use {{ll|Manual:shell.php|shell.php}} as a PHP [[w:REPL|REPL]] with full access to MediaWiki internals.
</div>

<span id="Client_side_debugging_(JavaScript)"></span>
== Отладка со стороны клиента (JavaScript) ==
<span lang="en" dir="ltr" class="mw-content-ltr">Wikipedia offers a rich set of tools for debugging client side JavaScript.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In addition to the MediaWiki tools, other techniques are available to assist with diagnosing client interactions.</span>

Инструменты:

<div lang="en" dir="ltr" class="mw-content-ltr">
* {{ll|ResourceLoader}} offers [[Special:MyLanguage/ResourceLoader/Developing with ResourceLoader#Debugging|a means to ensure JavaScript]] is easily viewable by client-side tools.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Open your browser's console.
</div> <span lang="en" dir="ltr" class="mw-content-ltr">Many client side mediawiki scripts log error messages to the console using ResourceLoader, which provides [[Special:MyLanguage/ResourceLoader/Modules#mediaWiki.log|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.</span> <span lang="en" dir="ltr" class="mw-content-ltr">[[Special:MyLanguage/ResourceLoader/Architecture#Debug_mode|ResourceLoader/Architecture#Debug_mode]] also describes this feature.</span>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Browser tools may provide native functionality to debug client side script.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Network tracers, like [https://www.wireshark.org/ Wireshark] can provide insight into the script that is being provided by a page.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* You can add <code>?debug=true</code> to your URL as in https://www.mediawiki.org/wiki/MediaWiki?debug=true to get more detailed information for debugging via your browser's console
</div>

<span id="See_also"></span>
== См. также ==
* {{ll|Manual:How to debug/Login problems}}
* {{ll|Manual:Profiling|Manual:Profiling}}
<div lang="en" dir="ltr" class="mw-content-ltr">
* ResourceLoader: [[Special:MyLanguage/ResourceLoader/Developing with ResourceLoader#Debugging|ResourceLoader/Developing with ResourceLoader#Debugging]]
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* All configuration variables related to debugging/logging: [[Special:MyLanguage/Manual:Configuration settings#Debug/logging|Manual:Configuration settings#Debug/logging]]
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Useful debugging tip: <code>throw new MWException( 'foo' );</code> (dies with the given message and prints the callstack)
</div>
* {{ll|Manual:Errors and symptoms}}
* {{ll|Category:Debug variables}}
* [[:wikitech:Debugging in production]] - <span lang="en" dir="ltr" class="mw-content-ltr">Debugging on Wikimedia's production cluster</span>
* {{ll|Help:Locating broken scripts}}

[[Category:MediaWiki development{{#translation:}}]]
[[Category:Log{{#translation:}}]]
[[Category:Debug{{#translation:}}]]