Migrate "WikiLambda API" instrument to use the Test Kitchen SDK
Closed, ResolvedPublic2 Estimated Story Points
Actions

Assigned To

Authored By

	phuedx
	Jan 22 2026, 12:10 PM

Project Tags

Referenced Files

None

Subscribers

Description

Background

The WikiLambda API instrument is the only instrument that uses EventLogging::getMetricsPlatformClient() and the MetricsClient class. Migrating this instrument to use the Test Kitchen SDK will unblock the deprecation and removal of that method and class.

AC

The instrument config is added to Test Kitchen UI
- The instrument has been registered
- The security review has been added to the instrument config
The instrument is rewritten to use InstrumentManager#getInstrument()
- https://gerrit.wikimedia.org/g/mediawiki/extensions/WikiLambda/+/1f98621e4fabbc3209a5c656fcfef6f075dbe786/includes/ActionAPI/WikiLambdaApiBase.php#578
The stream config is updated to reflect management via Test Kitchen
- https://gerrit.wikimedia.org/g/operations/mediawiki-config/+/4799083316924ee510febc57f238f8140c8ff7fb/wmf-config/ext-EventStreamConfig.php#3191
- Remove producers.metrics_platform_client.provide_values property
- Remove sample property
- Add a link to the instrument config in Test Kitchen UI
The stream is removed from wfEventLoggingStreamNames
- https://gerrit.wikimedia.org/g/operations/mediawiki-config/+/3ff486473879abe7eafcf61e60f09784ee5071eb/wmf-config/ext-EventLogging.php#88

Details

Related Changes in Gerrit:

Subject	Repo	Branch	Lines +/-
WikiLambdaApi instrument: update schema	mediawiki/extensions/WikiLambda	master	+1 -1
WikiLambdaApi instrument: update schema	mediawiki/extensions/WikiLambda	wmf/1.47.0-wmf.1	+1 -1
WikiLambdaApi: update stream configuration	operations/mediawiki-config	master	+2 -22
WikiLambdaApi instrument: Sets the custom schemaID	mediawiki/extensions/WikiLambda	wmf/1.47.0-wmf.1	+2 -0
WikiLambdaApi instrument: Sets the custom schemaID	mediawiki/extensions/WikiLambda	master	+2 -0
WikiLambdaAPI: update stream	operations/mediawiki-config	master	+0 -1
WikiLambda API instrument: Migrate to Test Kitchen	mediawiki/extensions/WikiLambda	master	+11 -19
Zuul: [mediawiki/extensions/WikiLambda] Add TestKitchen phan dep	integration/config	master	+1 -0

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T408059 [GOAL] Tidy up EventLogging
Open	None	T415260 Remove PHP Metrics Platform SDK
Resolved	Sfaci	T415246 Deprecate and remove EventLogging::getMetricsPlatformClient()
Resolved	Sfaci	T415254 Migrate "WikiLambda API" instrument to use the Test Kitchen SDK
Resolved	Sfaci	T409913 Create PHP equivalent of mw.testKitchen.getInstrument()
Resolved	phuedx	T367034 TestKitchen Extension: Merge PHP MetricsPlatform client library

Event Timeline

phuedx created this task.Jan 22 2026, 12:10 PM

phuedx added a subtask: T409913: Create PHP equivalent of mw.testKitchen.getInstrument().

phuedx updated the task description. (Show Details)Jan 22 2026, 12:12 PM

need DE here? Please re-add if so

Restricted Application added a project: Data-Engineering. · View Herald TranscriptJan 22 2026, 5:16 PM

Ahoelzl removed a project: Data-Engineering.Jan 22 2026, 5:26 PM

Restricted Application added a project: Data-Engineering. · View Herald TranscriptJan 22 2026, 5:26 PM

Ahoelzl moved this task from Incoming (new tickets) to Tag with Radar on the Data-Engineering board.Jan 22 2026, 5:26 PM

Ahoelzl added a project: Data-Engineering-Radar.

Sfaci moved this task from Incoming to Tidy up EventLogging on the Test Kitchen board.Feb 20 2026, 10:57 AM

JVanderhoop-WMF closed subtask T409913: Create PHP equivalent of mw.testKitchen.getInstrument() as Resolved.Mar 10 2026, 4:33 PM

JVanderhoop-WMF moved this task from Tidy up EventLogging to Backlog on the Test Kitchen board.

JVanderhoop-WMF set the point value for this task to 2.

JVanderhoop-WMF triaged this task as High priority.Mar 10 2026, 4:38 PM

KReid-WMF edited projects, added: Test Kitchen (Experiment Platform Sprint 21); removed: Test Kitchen.Mar 12 2026, 3:24 PM

Sfaci claimed this task.Mar 26 2026, 10:34 PM

Sfaci moved this task from Ready for Development to In Progress on the Test Kitchen (Experiment Platform Sprint 21) board.

Posting here some technical details provided by @DMartin-WMF from Abstract Wikipedia. They will be needed to register the instrument in Test Kitchen UI:

A preferred Instrument name + Machine-readable name: "WikiLambda API" and "WikiLambdaApi"
Description: API providing access to Wikifunctions, part of the WikiLambda extension
A related phabricator task: https://phabricator.wikimedia.org/T356228
A contact email: dmartin@wikimedia.org

The initial duration of the instrument will be one year and, once the initial end date have been reached, instruments owners will always be able to extend the duration of the instrument if needed (by updating its end date via Test Kitchen UI).

Sfaci updated the task description. (Show Details)Mar 30 2026, 10:02 PM

KReid-WMF edited projects, added: Test Kitchen (Test Kitchen (Experiment Platform Sprint 22)); removed: Test Kitchen (Experiment Platform Sprint 21).Apr 2 2026, 5:06 PM

KReid-WMF moved this task from Ready for Development to In Progress on the Test Kitchen (Test Kitchen (Experiment Platform Sprint 22)) board.

Change #1275466 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[mediawiki/extensions/WikiLambda@master] WikiLambda API instrument: Migrate to Test Kitchen

https://gerrit.wikimedia.org/r/1275466

gerritbot added a project: Patch-For-Review.Apr 20 2026, 4:36 PM

Change #1275914 had a related patch set uploaded (by Jforrester; author: Jforrester):

[integration/config@master] Zuul: [mediawiki/extensions/WikiLambda] Add TestKitchen phan dep

https://gerrit.wikimedia.org/r/1275914

Change #1275914 merged by jenkins-bot:

[integration/config@master] Zuul: [mediawiki/extensions/WikiLambda] Add TestKitchen phan dep

https://gerrit.wikimedia.org/r/1275914

Mentioned in SAL (#wikimedia-releng) [2026-04-21T13:34:33Z] <James_F> Zuul: [mediawiki/extensions/WikiLambda] Add TestKitchen phan dep, for T415254

KReid-WMF edited projects, added: Test Kitchen (Experiment Platform Sprint 23); removed: Test Kitchen (Test Kitchen (Experiment Platform Sprint 22)).Apr 23 2026, 3:15 PM

KReid-WMF moved this task from Ready for Development to In Progress on the Test Kitchen (Experiment Platform Sprint 23) board.

Sfaci moved this task from In Progress to Needs Review on the Test Kitchen (Experiment Platform Sprint 23) board.Apr 24 2026, 3:55 PM

Sfaci moved this task from Needs Review to In Progress on the Test Kitchen (Experiment Platform Sprint 23) board.

Change #1275466 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] WikiLambda API instrument: Migrate to Test Kitchen

https://gerrit.wikimedia.org/r/1275466

Maintenance_bot removed a project: Patch-For-Review.Apr 28 2026, 11:31 AM

ReleaseTaggerBot added a project: MW-1.47-notes (1.47.0-wmf.1; 2026-05-05).Apr 28 2026, 12:00 PM

Sfaci updated the task description. (Show Details)Apr 28 2026, 2:56 PM

Change #1278704 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[operations/mediawiki-config@master] WikiLambdaApi: update stream configuration

https://gerrit.wikimedia.org/r/1278704

Change #1278705 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[operations/mediawiki-config@master] WikiLambdaAPI: update stream

https://gerrit.wikimedia.org/r/1278705

Change #1278705 abandoned by Santiago Faci:

[operations/mediawiki-config@master] WikiLambdaAPI: update stream

Reason:

duplicated

https://gerrit.wikimedia.org/r/1278705

Sfaci moved this task from In Progress to Needs Review on the Test Kitchen (Experiment Platform Sprint 23) board.Apr 28 2026, 11:24 PM

Sfaci moved this task from Needs Review to BLOCKED on the Test Kitchen (Experiment Platform Sprint 23) board.Apr 29 2026, 11:49 AM

Sfaci moved this task from BLOCKED to To Deploy on the Test Kitchen (Experiment Platform Sprint 23) board.May 4 2026, 8:24 AM

Sfaci updated the task description. (Show Details)

Change #1285330 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[mediawiki/extensions/WikiLambda@master] WikiLambdaApi instrument: Sets the custom schemaID

https://gerrit.wikimedia.org/r/1285330

Sfaci moved this task from To Deploy to Needs Review on the Test Kitchen (Experiment Platform Sprint 23) board.May 8 2026, 11:05 AM

Change #1285330 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] WikiLambdaApi instrument: Sets the custom schemaID

https://gerrit.wikimedia.org/r/1285330

Change #1285352 had a related patch set uploaded (by Jforrester; author: Santiago Faci):

[mediawiki/extensions/WikiLambda@wmf/1.47.0-wmf.1] WikiLambdaApi instrument: Sets the custom schemaID

https://gerrit.wikimedia.org/r/1285352

Sfaci moved this task from Needs Review to To Deploy on the Test Kitchen (Experiment Platform Sprint 23) board.May 8 2026, 12:24 PM

ReleaseTaggerBot edited projects, added: MW-1.47-notes (1.47.0-wmf.2; 2026-05-12); removed: MW-1.47-notes (1.47.0-wmf.1; 2026-05-05).May 8 2026, 1:00 PM

WikiLambdaApi instrument was deployed already but there is a fix to set the right schema in the instrument code and it's scheduled to be deployed on May 11th during the morning backport window.

Also at that time, another patch will be deployed to tidy up the related stream to remove the contextual attributes declared there and the sample_rate because they are not needed: contextual attributes are now defined in Test Kitchen UI and sample_rate is not supported by the PHP Test Kitchen SDK

Change #1285352 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@wmf/1.47.0-wmf.1] WikiLambdaApi instrument: Sets the custom schemaID

https://gerrit.wikimedia.org/r/1285352

Change #1278704 merged by jenkins-bot:

[operations/mediawiki-config@master] WikiLambdaApi: update stream configuration

https://gerrit.wikimedia.org/r/1278704

Mentioned in SAL (#wikimedia-operations) [2026-05-11T14:20:38Z] <lucaswerkmeister-wmde@deploy1003> Started scap sync-world: Backport for [[gerrit:1285448|Grant 'createpreviouslyrenamedaccount' to account creators and sysop-likes (T196386)]], [[gerrit:1278704|WikiLambdaApi: update stream configuration (T415254)]], [[gerrit:1285352|WikiLambdaApi instrument: Sets the custom schemaID (T415254)]], [[gerrit:1285406|editSaves: getExperiment returns a promise now (T425785)]]

Mentioned in SAL (#wikimedia-operations) [2026-05-11T14:26:18Z] <lucaswerkmeister-wmde@deploy1003> lucaswerkmeister-wmde, jforrester, matmarex, sfaci: Backport for [[gerrit:1285448|Grant 'createpreviouslyrenamedaccount' to account creators and sysop-likes (T196386)]], [[gerrit:1278704|WikiLambdaApi: update stream configuration (T415254)]], [[gerrit:1285352|WikiLambdaApi instrument: Sets the custom schemaID (T415254)]], [[gerrit:1285406|editSaves: getExperiment returns a promise now

Maintenance_bot removed a project: Patch-For-Review.May 11 2026, 2:31 PM

Mentioned in SAL (#wikimedia-operations) [2026-05-11T14:39:28Z] <lucaswerkmeister-wmde@deploy1003> Finished scap sync-world: Backport for [[gerrit:1285448|Grant 'createpreviouslyrenamedaccount' to account creators and sysop-likes (T196386)]], [[gerrit:1278704|WikiLambdaApi: update stream configuration (T415254)]], [[gerrit:1285352|WikiLambdaApi instrument: Sets the custom schemaID (T415254)]], [[gerrit:1285406|editSaves: getExperiment returns a promise now (T425785)]] (duration: 18

ReleaseTaggerBot edited projects, added: MW-1.47-notes (1.47.0-wmf.1; 2026-05-05); removed: MW-1.47-notes (1.47.0-wmf.2; 2026-05-12).May 11 2026, 3:00 PM

Sfaci moved this task from To Deploy to In Progress on the Test Kitchen (Experiment Platform Sprint 23) board.May 11 2026, 3:24 PM

sfaci opened https://gitlab.wikimedia.org/repos/data-engineering/schemas-event-secondary/-/merge_requests/121

Updated to inherit from web/base 2.0.0

Change #1285857 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[mediawiki/extensions/WikiLambda@master] WikiLambdaApi instrument: update schema

https://gerrit.wikimedia.org/r/1285857

Sfaci moved this task from In Progress to Needs Review on the Test Kitchen (Experiment Platform Sprint 23) board.May 11 2026, 4:14 PM

Patches above represent some additional work I didn't realize before. The schema that the instrument was using didn't include instrument_name as a field and Test Kitchen is including it since recently. So:

A new schema version has been published: /analytics/mediawiki/product_metrics/wikilambda/api/2.0.0 -> https://gitlab.wikimedia.org/repos/data-engineering/schemas-event-secondary/-/merge_requests/121
A patch has been submitted to update the instrument code use that schemaID -> https://gerrit.wikimedia.org/r/1285857

sfaci merged https://gitlab.wikimedia.org/repos/data-engineering/schemas-event-secondary/-/merge_requests/121

Updated to inherit from web/base 2.0.0

Sfaci moved this task from Needs Review to To Deploy on the Test Kitchen (Experiment Platform Sprint 23) board.May 11 2026, 8:32 PM

Change #1285857 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] WikiLambdaApi instrument: update schema

https://gerrit.wikimedia.org/r/1285857

Change #1285916 had a related patch set uploaded (by Clare Ming; author: Santiago Faci):

[mediawiki/extensions/WikiLambda@wmf/1.47.0-wmf.1] WikiLambdaApi instrument: update schema

https://gerrit.wikimedia.org/r/1285916

Change #1285916 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@wmf/1.47.0-wmf.1] WikiLambdaApi instrument: update schema

https://gerrit.wikimedia.org/r/1285916

Mentioned in SAL (#wikimedia-operations) [2026-05-11T21:45:14Z] <cjming@deploy1003> Started scap sync-world: Backport for [[gerrit:1285916|WikiLambdaApi instrument: update schema (T415254)]]

Mentioned in SAL (#wikimedia-operations) [2026-05-11T21:47:01Z] <cjming@deploy1003> cjming: Backport for [[gerrit:1285916|WikiLambdaApi instrument: update schema (T415254)]] synced to the testservers (see https://wikitech.wikimedia.org/wiki/Mwdebug). Changes can now be verified there.

Mentioned in SAL (#wikimedia-operations) [2026-05-11T21:51:40Z] <cjming@deploy1003> Finished scap sync-world: Backport for [[gerrit:1285916|WikiLambdaApi instrument: update schema (T415254)]] (duration: 06m 26s)