Jump to content

This is a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Test Kitchen/SDK/PHP SDK

From Wikitech

This page provides a guide to using the PHP Test Kitchen SDK for instrument and experiment creators.

Quickstart

Example patch: gerrit:1017961

Setup

To set up a local development environment for writing instrument code, follow the setup guide for MediaWiki and Test Kitchen . For more context and tooling recommendations, see the introduction to Test Kitchen development .

Submit an interaction event

An interaction event is meant to represent a basic interaction with some target or some event occurring. For example, a user hovers over a UI element or an app notifies the server of its current state.

Here's an example of an instrument that uses PHP SDK to submit an event when a user hovers over an interwiki link. 

$action = 'hover';
$interactionData = [
    'action_source' => 'value for action source',
	'action_context' => 'value for action context'
];

$instrumentManager = MediaWikiServices::getInstance()->getService( 'TestKitchen.Sdk.InstrumentManager' );
$instrument = $instrumentManager( 'my-machine-readable-instrument-name' );

// submit the interaction event
$instrument->send( $action, $interactionData );

The resulting event:

  • includes the specified value of action
  • includes optional interaction data you have provided in interactionData . This data must validate against the specified schema (See the interaction data fields supported by the base schema for web )
  • is published to the event stream you defined while registering the instrument in Test Kitchen UI
  • is validated against the specified schema (the one defined in the stream above)

Implementation

The PHP SDK is provided by the the TestKitchen extension .

Like the JavaScript SDK, when $wgEventLoggingStreamNames is falsy the PHP SDK will not validate whether the destination stream is configured before submitting the event to the destination event service.

The PHP SDK does not support sampling by pageview ID or session ID because they are not known to the server (i.e., the PHP layer of MediaWiki). Sampling support can be added if and when there is a use case for it and an appropriate sampling unit defined.

Reference

Instruments

Instrument#send

Sends an event to the stream that is configured within the current instrument, and it will be validated against the corresponding schema

Parameters :

Instrument#setSchema

Sets the ID of the schema to validate analytics events sent with

Parameters :

  • schemaID (string) : schemaID

Experiments

Experiment#send

Sends an event to the stream that is configured within the current instrument, and it will be validated against the corresponding schema

Parameters :

Experiment#getAssignedGroup

Gets the group the current user was assigned by the Experiment Enrollment Sampling Authority (EESA) when they were enrolled in this experiment.

Experiment#isAssignedGroup

Gets whether the assigned group for the current user in this experiment is one of the given groups

Parameters :

  • groups (string...) : Name of the groups you want to check


Instrument#setSchema

Sets the ID of the schema to validate analytics events sent with

Parameters :

  • schemaID (string) : schemaID
Retrieved from " https://wikitech.wikimedia.org/w/index.php?title=Test_Kitchen/SDK/PHP_SDK&oldid=2381473 "