Extension:MetricsPlatform

MediaWiki extensions manual

Experimentation Lab Release status: stable
Description	Provides the PHP and JS Experimentation Lab SDKs, which developers use to implement experiments
Author(s)	The Experiment Platform team
Compatibility policy	Master maintains backward compatibility.
MediaWiki
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
Help	Help:Extension:MetricsPlatform
Translate the MetricsPlatform extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The MetricsPlatform extension is maintained by the Experiment Platform team at the Wikimedia Foundation. Read more about the Metrics Platform project.

This page will be updated as usage and local setup steps are defined.

Installation

• Download and move the extracted MetricsPlatform 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/MetricsPlatform
  

• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'MetricsPlatform' );
  

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

Configuration

• Setting xLab URL:

$wgMetricsPlatformInstrumentConfiguratorBaseUrl = 'https://mpic.wikimedia.org';

• Enable fetching instrument configs from xLab during the request:

$wgMetricsPlatformEnableStreamConfigsFetching = true;

• Enable generating event stream configs from instrument configs fetched from xLab:

$wgMetricsPlatformEnableStreamConfigsMerging = true;

• Enable experimentation capabilities:

$wgMetricsPlatformEnableExperiments = true;

• Enable fetching experiment configs from xLab during the request:

$wgMetricsPlatformEnableExperimentConfigsFetching = true;

• Enabling experiment enrollment overriding (see Overriding_experiment_enrollment for details):

$wgMetricsPlatformEnableExperimentOverrides = true;