View source for Manual:Profiling/ja

<languages />
'''プロファイリング'''は、ページ操作中のコード実行を追跡し、特定の機能に費やされたコード実行が全体に占める割合を報告します。
<span lang="en" dir="ltr" class="mw-content-ltr">Profiling is an advanced task intended for developers and system administrators to track sources of slowness in MediaWiki that should be optimized.</span>

<span id="PHP_profiling"></span>
== PHP プロファイリング ==

<div lang="en" dir="ltr" class="mw-content-ltr">
You can use [https://github.com/tideways/php-xhprof-extension Tideways] or [https://xdebug.org/ XDebug]. These PHP extensions provide tracing and profiling capabilities.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Tideways also advertises a proprietary UI to visualize results, but you don't need that.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Install the <code>php-tideways</code> package on Debian/Ubuntu, or [https://github.com/tideways/homebrew-profiler Homebrew] on macOS.
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">For XDebug, see [https://xdebug.org/docs/profiler XDebug profiling documentation].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For command line scripts, you can use <code>php -d xdebug.mode=profile maintenance/{script}</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">[https://github.com/jokkedk/webgrind Webgrind] can then be used to view profile results.</span>

<span id="MediaWiki_custom_profiler"></span>
== MediaWiki カスタム プロファイラー ==
{{note|1=<span lang="en" dir="ltr" class="mw-content-ltr">The custom MediaWiki profiling calls (<code>wfProfileIn</code>/<code>wfProfileOut</code>) are deprecated, were no-ops since MediaWiki 1.25+, and were [[gerrit:414068|removed in 1.31]].</span>}}

{{MW 1.25|and after}}
<span lang="en" dir="ltr" class="mw-content-ltr">In MediaWiki 1.25 profiling was completely rewritten and many settings previous relating to profiling were removed in favor of consolidating them as parameters to $wgProfiler.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Notably, output has been separated from class types.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For documentation about profiling prior to 1.25, see an [[Special:Permalink/1281616|older version]] of this page.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Example {{ll|Manual:$wgProfiler|$wgProfiler}} configuration:
</div>

<syntaxhighlight lang="php">
<?php
$wgProfiler['class'] = 'ProfilerXhprof';
$wgProfiler['output'] = [ 'ProfilerOutputText' ];
$wgProfiler['visible'] = true;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Each of these parameters (and more) are described in detail:
</div>

; class
: 'ProfilerXhprof'. <span lang="en" dir="ltr" class="mw-content-ltr">ProfilerXhprof is new in MediaWiki 1.25 and provides an Xhprof-backed profiler that captures profiling data for all functions as well as sub-functional units.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Old values such as ProfilerStandard, ProfilerUDP, ProfilerDB, etc do not work.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Even if you are using Tideways, still specify the ProfilerXhprof class.</span>
; output
: <span lang="en" dir="ltr" class="mw-content-ltr">One or more of 'ProfilerOutputText', 'ProfilerOutputDump', 'ProfilerOutputStats'<ref>See {{git|750e4eb9d9517da68a4df08bf50a9a360dafeb05}}</ref>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Text outputs the information in either HTML comments or after the skin.</span> <span lang="en" dir="ltr" class="mw-content-ltr">UDP is a format send to a udpprofile daemon.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Dump produces a dump of the profiling info for use with xhprof GUI (xhprofgui role on [[Special:MyLanguage/MediaWiki-Vagrant#Using roles|Vagrant setup]]).</span>
; outputDir
: <span lang="en" dir="ltr" class="mw-content-ltr">Only applies to 'ProfilerOutputDump' format.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Required to specify where the dump files will be stored.</span>
; visible
: <span lang="en" dir="ltr" class="mw-content-ltr">Only applies to 'ProfilerOutputText' format.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Whether text is shown after the skin or in an HTML comment.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Maintenance scripts ===
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">{{ll|Manual:Maintenance scripts|Maintenance scripts}} support a --profiler option.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This changes the output method of the profiler as well as ensuring its enabled in the CLI.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Because this only changes the output method and not the profiler class, you still must have some sort of profiling setup in <code>$wgProfiler</code>.</span>


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

<div lang="en" dir="ltr" class="mw-content-ltr">
If you get "Fatal error: Uncaught Exception: Neither xhprof nor tideways are installed" then you need to do:
</div>

<syntaxhighlight lang="php">
$ sudo apt install php-tideways
$ sudo service apache2 restart
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
If you still get an error, then take a look at https://tideways.com/profiler/xhprof-for-php7
</div>

<span id="Output"></span>
== 出力 ==

テキストをこのように出力します

<syntaxhighlight lang="text">
100.00% 508.972      1 - main()
 96.67% 492.003      1 - MediaWiki::run
 96.61% 491.699      1 - MediaWiki::main
 87.12% 443.434      1 - MediaWiki::performRequest
 84.16% 428.356      1 - SpecialPageFactory::executePath
 84.11% 428.073      1 - SpecialPage::run
 84.10% 428.058      1 - SpecialRecentChanges::execute
 63.82% 324.838      1 - ChangesListSpecialPage::execute
 57.07% 290.495      1 - ChangesListSpecialPage::webOutput
 51.06% 259.877      1 - SpecialRecentChanges::outputChangesList
 44.72% 227.633    397 - Wikimedia\Rdbms\Database::query
 31.07% 158.155    922 - Message::fetchMessage
 30.61% 155.788    865 - MessageCache::get
 29.55% 150.398    398 - Wikimedia\Rdbms\Database::doProfiledQuery
 29.39% 149.570    865 - MessageCache::getMessageFromFallbackChain
 29.26% 148.923    869 - MessageCache::getMessageForLang
 29.06% 147.931    393 - Wikimedia\Rdbms\Database::select
 27.30% 138.962      1 - EnhancedChangesList::endRecentChangesList
 27.30% 138.960      1 - EnhancedChangesList::recentChangesBlock
...
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
The first column is the time percent; the second column is the [[Special:MyLanguage/Manual:Profiling table#pf time|time]] (in ms); the third column is the [[Special:MyLanguage/Manual:Profiling table#pf count|count]]; and the fourth column is the [[Special:MyLanguage/Manual:Profiling table#pf name|name]] of the method.
</div>

<span id="See_also"></span>
==関連項目==
* {{ll|Manual:Performance tuning}}
* {{ll|Manual:How to debug}}

<span id="Footnotes"></span>
== 脚注 ==
<references />
== Code steward ==
{{Component|mediawiki-core-profiler}}

[[Category:Performance tuning{{#translation:}}]]
[[Category:MediaWiki development{{#translation:}}]]