You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org
Debugging in production: Difference between revisions
imported>Krinkle |
imported>Krinkle (rm quotes for ::$HOSTNAME. The hostname won't contain spaces and this makes it feel just simple enough to memorise and type on your own. The added quotes made it feel as a "thing" that a less experienced person might be inclined to revisit this page for each time.) |
||
| Line 8: | Line 8: | ||
=== Locally === | === Locally === | ||
You can make a local self request from any web server by using curl, like so, for a regular MediaWiki request over HTTPS:<syntaxhighlight lang="bash"> | You can make a local self request from any web server by using curl, like so, for a regular MediaWiki request over HTTPS:<syntaxhighlight lang="bash"> | ||
mwdebug1002$ curl -i --connect-to | mwdebug1002$ curl -i --connect-to ::$HOSTNAME 'https://test.wikipedia.org/w/load.php' | ||
HTTP/1.1 200 OK | HTTP/1.1 200 OK | ||
Server: mwdebug1002.eqiad.wmnet | Server: mwdebug1002.eqiad.wmnet | ||
| Line 15: | Line 15: | ||
</syntaxhighlight>Or over HTTP:<syntaxhighlight lang="bash"> | </syntaxhighlight>Or over HTTP:<syntaxhighlight lang="bash"> | ||
mwdebug1002$ curl -i --connect-to | mwdebug1002$ curl -i --connect-to ::$HOSTNAME 'http://test.wikipedia.org/wiki/Main_Page' | ||
HTTP/1.1 302 Found | HTTP/1.1 302 Found | ||
Server: mwdebug1002.eqiad.wmnet | Server: mwdebug1002.eqiad.wmnet | ||
| Line 21: | Line 21: | ||
</syntaxhighlight><syntaxhighlight lang="bash"> | </syntaxhighlight><syntaxhighlight lang="bash"> | ||
mwdebug1001$ curl -i --connect-to | mwdebug1001$ curl -i --connect-to ::$HOSTNAME 'http://www.wikimedia.org/' | ||
HTTP/1.1 200 OK | HTTP/1.1 200 OK | ||
Server: mwdebug1001.eqiad.wmnet | Server: mwdebug1001.eqiad.wmnet | ||
| Line 33: | Line 33: | ||
… | … | ||
</syntaxhighlight>And over HTTP as if from an external HTTPS request (This is currently the only way to debug in Beta Cluster, since [[phab:T206158|internal HTTPS is not available there]]):<syntaxhighlight lang="bash"> | </syntaxhighlight>And over HTTP as if from an external HTTPS request (This is currently the only way to debug in Beta Cluster, since [[phab:T206158|internal HTTPS is not available there]]):<syntaxhighlight lang="bash"> | ||
deployment-mediawiki11$ curl -i --connect-to | deployment-mediawiki11$ curl -i --connect-to ::$HOSTNAME -H 'X-Forwarded-Proto: https' 'http://en.wikipedia.beta.wmflabs.org/wiki/Main_Page' | ||
HTTP/1.1 200 OK | HTTP/1.1 200 OK | ||
Server: deployment-mediawiki11.deployment-prep.eqiad1.wikimedia.cloud | Server: deployment-mediawiki11.deployment-prep.eqiad1.wikimedia.cloud | ||
| Line 44: | Line 44: | ||
'''Note''' '''about Host header''': Prior to 2015, the more traditional approach of using <code>curl '<nowiki>http://localhost/wiki/Main_Page'</nowiki> -H 'Host: test.wikipedia.org'</code> was supported, but per [[phab:T190111|T190111]] this is no longer possible because connections via "localhost" are handled by a higher priority VirtualHost in Apache that serves responses for the health status checks (not related to MediaWiki). | '''Note''' '''about Host header''': Prior to 2015, the more traditional approach of using <code>curl '<nowiki>http://localhost/wiki/Main_Page'</nowiki> -H 'Host: test.wikipedia.org'</code> was supported, but per [[phab:T190111|T190111]] this is no longer possible because connections via "localhost" are handled by a higher priority VirtualHost in Apache that serves responses for the health status checks (not related to MediaWiki). | ||
'''Note about FQDN address''': Prior to 2019, it was common to workaround the above "localhost" issue by using | '''Note about FQDN address''': Prior to 2019, it was common to workaround the above "localhost" issue by using the internal FQDN (mw0000.eqiad.wmnet) or its internal IP address instead. This is easiest via <code>$HOSTNAME</code> or <code>$(hostname -f)</code>, e.g. like <code>curl -i -H 'Host: test.wikipedia.org' "<nowiki>http://$HOSTNAME/w/load.php</nowiki>"</code>. While this still works today for HTTP requests, it does not work reliably for HTTPS requests since the web server in question has no certificate for the internal hostname, though this could be bypassed with <code>curl --insecure</code> (or <code>curl -k</code> for short). | ||
'''Note about --resolve option''': Prior to 2020, other documentation pages recommended <code>--resolve</code> as the main strategy, e.g. <code>curl -i --resolve "test.wikipedia.org:443:$(hostname -i)" '<nowiki>https://test.wikipedia.org/w/load.php'</nowiki></code>. This still works perfectly today and is functionally equivalent to the current recommendation with <code>--connect-to</code>. The <code>--resolve</code> option is no longer recommended because it is too easy to misuse and not realize that it was silently ignored. For example, if | '''Note about --resolve option''': Prior to 2020, other documentation pages recommended <code>--resolve</code> as the main strategy, e.g. <code>curl -i --resolve "test.wikipedia.org:443:$(hostname -i)" '<nowiki>https://test.wikipedia.org/w/load.php'</nowiki></code>. This still works perfectly today and is functionally equivalent to the current recommendation with <code>--connect-to</code>. The <code>--resolve</code> option is no longer recommended because it is too easy to misuse and not realize that it was silently ignored. For example, if you specify "resolve" with a different hostname than your URL (with redirects, there can be many host names involved), curl will silently connect to the main production edge for your first and only request, which is easy to miss if you don't enable verbose <code>-v</code> mode and check what server it actually connected to. This can be mitigated by using a wildcard hostname like <code>--resolve "*:443:$(hostname -i)"</code> but that still requires getting the port right, which means over HTTP, it would silently get ignored again, plus it requires the IP address and thus the extra hostname command. The <code>--connect-to</code> option has the benefit of allowing both host and port to be omitted, and supports a hostname as destination (instead of IP address), thus allowing the simpler and more memorable <code>"::$HOSTNAME"</code> form. | ||
== Pushing code to a debug server == | == Pushing code to a debug server == | ||
{{Outdated-inline|year=2018}} | {{Outdated-inline|year=2018}} | ||
Revision as of 00:57, 10 April 2022
Debugging a web request
Externally
Use X-Wikimedia-Debug to make a request bypass Varnish cache and route to a specific debug server.
Locally
You can make a local self request from any web server by using curl, like so, for a regular MediaWiki request over HTTPS:
mwdebug1002$ curl -i --connect-to ::$HOSTNAME 'https://test.wikipedia.org/w/load.php'
HTTP/1.1 200 OK
Server: mwdebug1002.eqiad.wmnet
…
/* This file is theWeb entry point for MediaWiki's ResourceLoader: … */
Or over HTTP:
mwdebug1002$ curl -i --connect-to ::$HOSTNAME 'http://test.wikipedia.org/wiki/Main_Page'
HTTP/1.1 302 Found
Server: mwdebug1002.eqiad.wmnet
Location: https://test.wikipedia.org/wiki/Main_Page
mwdebug1001$ curl -i --connect-to ::$HOSTNAME 'http://www.wikimedia.org/'
HTTP/1.1 200 OK
Server: mwdebug1001.eqiad.wmnet
…
<!DOCTYPE html>
<html lang="mul" dir="ltr">
<head>
<meta charset="utf-8">
<title>Wikimedia</title>
<meta name="description" content="Wikimedia is a global movement whose mission is to bring free educational content to the world.">
…
And over HTTP as if from an external HTTPS request (This is currently the only way to debug in Beta Cluster, since internal HTTPS is not available there):
deployment-mediawiki11$ curl -i --connect-to ::$HOSTNAME -H 'X-Forwarded-Proto: https' 'http://en.wikipedia.beta.wmflabs.org/wiki/Main_Page'
HTTP/1.1 200 OK
Server: deployment-mediawiki11.deployment-prep.eqiad1.wikimedia.cloud
…
<!DOCTYPE html>
…
Note about Host header: Prior to 2015, the more traditional approach of using curl 'http://localhost/wiki/Main_Page' -H 'Host: test.wikipedia.org' was supported, but per T190111 this is no longer possible because connections via "localhost" are handled by a higher priority VirtualHost in Apache that serves responses for the health status checks (not related to MediaWiki).
Note about FQDN address: Prior to 2019, it was common to workaround the above "localhost" issue by using the internal FQDN (mw0000.eqiad.wmnet) or its internal IP address instead. This is easiest via $HOSTNAME or $(hostname -f), e.g. like curl -i -H 'Host: test.wikipedia.org' "http://$HOSTNAME/w/load.php". While this still works today for HTTP requests, it does not work reliably for HTTPS requests since the web server in question has no certificate for the internal hostname, though this could be bypassed with curl --insecure (or curl -k for short).
Note about --resolve option: Prior to 2020, other documentation pages recommended --resolve as the main strategy, e.g. curl -i --resolve "test.wikipedia.org:443:$(hostname -i)" 'https://test.wikipedia.org/w/load.php'. This still works perfectly today and is functionally equivalent to the current recommendation with --connect-to. The --resolve option is no longer recommended because it is too easy to misuse and not realize that it was silently ignored. For example, if you specify "resolve" with a different hostname than your URL (with redirects, there can be many host names involved), curl will silently connect to the main production edge for your first and only request, which is easy to miss if you don't enable verbose -v mode and check what server it actually connected to. This can be mitigated by using a wildcard hostname like --resolve "*:443:$(hostname -i)" but that still requires getting the port right, which means over HTTP, it would silently get ignored again, plus it requires the IP address and thus the extra hostname command. The --connect-to option has the benefit of allowing both host and port to be omitted, and supports a hostname as destination (instead of IP address), thus allowing the simpler and more memorable "::$HOSTNAME" form.
Pushing code to a debug server
 | This information is outdated. (last update: 2018) |
Developers can put code updates on one of the mwdebug hosts, before deploying to the entire production cluster, see Pre-deployment testing in production .
Conditional code
Note that any changes you make this way will be overwritten by cluster-wide deployments. So, long-term changes should go into a block wrapped in an if ( $wgDBname === 'testwiki' ) (to prevent them from accidentally running on all wikis!). Short-term changes (anything not committed to the git repo) should either be committed and rolled out, or reverted as soon as possible.
PHP7 Opcache
When editing files on a debug server directly, remember to clear the PHP7 opcache afterwards. Without this, changes to files on disk might not take affect.
mwdebug1001$ php7adm /opcache-free
When using Scap to pull down a change from the deployment host, this happens automatically.
Testing it
Use X-Wikimedia-Debug in a browser to route one of your regular web requests to the debug server you have staged code on.
Debugging databases
From a maintenance host, use the sql command, or use mwscript mysql.php directly.
In particular, take note that in MediaWiki some of our DB clusters have a different name. For example "x1" and "x2" are known as "extension1" and "extension2", for the purposes of the sql --cluster parameter and internal values of $wgLBFactoryConf that this corresponds with.
Examples:
$ sql test2wiki
# Connected to s3.test2wiki database on a live replica in production.
$ sql centralauth
# Connected to s7.centralauth
$ mwscript mysql.php --wiki aawiki --wikidb centralauth
# (idem)
$ sql wikishared
# Connected to x1.centralauth
$ mwscript mysql.php --wiki aawiki --cluster extension1 --wikidb wikishared
# (idem)
$ mwscript mysql.php --wiki aawiki --cluster extension2 --list-hosts
db0001
db0002
db0003
Debugging a maintenance script
| This information is outdated. (last update: 2018) |
ssh to a mwdebug host, then:
source /usr/local/lib/mw-deployment-vars.sh
sudo -u "$MEDIAWIKI_WEB_USER" php -m debug "$MEDIAWIKI_DEPLOYMENT_DIR/multiversion/MWScript.php" someScript.php --wiki=testwiki --scriptSpecificParameters "goHere"
Debugging logs
To locally debug messages sent to Logstash from MediaWiki or php-fpm, read Application_servers/Runbook#Logging.
Debugging in shell
| This information is outdated. (last update: 2018) |
To open a debugger, run:
mwrepl wikidbname
on mwmaint1002. wikidbname is e.g. eswiki. You can set breakpoints, then call arbitrary MW code.
Debugging action API requests in shell
Sometimes, it is convenient to debug through the action API. Since this is a user-facing entry point, it allows testing user parameters and permission checks.
Start by opening mwrepl as above. Then use:
define( 'MW_API', true ); // Signal this is api.php.
$wgUser = User::newFromName( <Username> );
$wgTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/dummy title in manual testing' );
$token = $wgUser->getEditToken( '', $wgRequest ); // Although write actions will result in strange logs
$params = [ 'action' => '<action>', 'token' => $token, /* etc */ ];
$request = new DerivativeRequest( $wgRequest, $params, /* $wasPosted = */ true );
$request->setIP( '127.0.0.1' ); // An IP must be set
$context = RequestContext::getMain();
$context->setUser( $wgUser );
$context->setTitle( $wgTitle );
$context->setRequest( $request );
$main = new ApiMain( $context, true );
wfRunHooks( 'ApiBeforeMain', array( &$main ) ); // For CirrusSearch and other extensions
$main->execute();
// Examine $main->getResult()->getResultData() or whatever else you need to do
For code that is not specific to the shell, and more details on internal requests, see mw:API:Calling internally.