MediaWiki extensions manual

NavigationTiming Release status: stableCategory:Stable extensions
Implementation	AjaxCategory:Ajax extensions
Description	Logs perceived latency measurements from client-side
Author(s)	Patrick Reilly, Ori Livneh, Asher Feldman, Timo Tijhof, Ian Marlier
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.Category:Extensions with release branches compatibility policy
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball Category:Extensions in Wikimedia version control README
Parameters $wgNavigationTimingSamplingFactor $wgNavigationTimingCpuBenchmarkSamplingFactor
Hooks used BeforePageDisplay Category:BeforePageDisplay extensions
Quarterly downloads	4 (Ranked 106th)
Public wikis using	846 (Ranked 308th)
Translate the NavigationTiming extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The NavigationTiming extension measures perceived latency in browsers. The extension is named after the W3C Navigation Timing API in web browsers, but today collects metrics from several different browser APIs.

FAQ

How is the information used?

Engineers at Wikimedia Foundation intend to use this data to assess the impact (positive and negative) of changes to application code and server configuration. Thus guiding on-going work on site performance.

Dependencies

• EventLogging

Installation

• Download and move the extracted NavigationTiming folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/NavigationTiming
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'NavigationTiming' );
  $wgNavigationTimingSamplingFactor = 1;  // 100% (1 of every 1)
  

• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Further reading

About the data we collect:

• Explainer of navtiming metrics, Wikitech.
• Wikimedia Grafana: Navigation Timing dashboard, grafana.wikimedia.org
• Performance infrastructure, Wikitech.

About the Navigation Timing API in web browsers:

• Navigation Timing API, specification from the W3C.
• Annotated Timing object: simplified descriptions of the measurements.
• Measuring Page Load Speed with Navigation Timing, HTML5 Rocks.

Code stewardship

• Maintained by Unknown or Unassigned^{[‍Maintainers page]}.
• Issue tracker: Phabricator MediaWiki-extensions-NavigationTiming (Report an issue)

Footnotes

This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.