Update the Metrics Platform JS Client Library API to talk about Instrument Name
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To

Authored By

	phuedx
	Jun 6 2024, 5:19 PM

Description

Background

Following on from the changes made as part of the parent task, there is an opportunity to improve the Developer Experience (DX) for instrument developers. The detail of the changes and API proposal are detailed here and the overview is quoted below:

Instruments using MetricsClient#submitInteraction() and other methods will need to repeat the streamName and schemaID parameters on every invocation. In order to allow instrument maintainers to keep their instruments DRY, I propose adding the Instrument class, a class that has a MetricsClient-like interface but is bound to a specific {streamName,schemaID} pair.

AC

MR 42 is reviewed and merged
The MR is updated to reflect the description
The MR is reviewed and merged
A new version of the JS Metrics Platform Client Library is released and deployed
- Done in https://gerrit.wikimedia.org/r/c/mediawiki/extensions/EventLogging/+/1070992
Metrics Platform/JavaScript API is updated

Notes

We could base our work off of this MR: https://gitlab.wikimedia.org/repos/data-engineering/metrics-platform/-/merge_requests/39

Details

Related Changes in GitLab:

Title	Reference	Author	Source Branch	Dest Branch
[JS] Disable type checking for src/Instrument.js	repos/data-engineering/metrics-platform!68	phuedx	work/phuedx/T366827-follow-up	main
Allow MetricsClient#newInstrument(instrumentName)	repos/data-engineering/metrics-platform!67	phuedx	work/phuedx/T366827	main
[JS] Extract EventSubmitter interface	repos/data-engineering/metrics-platform!42	phuedx	work/phuedx/event_submitter	main
[JS] Create Instrument class/newInstrument API	repos/data-engineering/metrics-platform!39	phuedx	work/phuedx/submitter	main

Customize query in GitLab

Related Objects
Search...

Status	Assigned	Task
Resolved	Sfaci	T366949 MPIC: Add stream name to forms/database/api
Resolved	phuedx	T366807 [EPIC] Update Metrics Platform Client Libraries to accept instrument name
Resolved	phuedx	T366827 Update the Metrics Platform JS Client Library API to talk about Instrument Name
Resolved	cjming	T366802 Update Metrics Platform Base Schemas to include instrument name
Resolved	• JEbe-WMF	T368326 Update Metrics Platform Client Libraries to accept experiment membership
Invalid	None	T374744 Update Metrics Platform Java library to include experiment enrollment
Resolved	Sgs	T371498 Metrics Platform Integration: PoC for tracking impressions of the Community Updates homepage module
Resolved	Sfaci	T382469 EPIC: update documentation for experiment enrollment

Event Timeline

phuedx created this task.Jun 6 2024, 5:19 PM

phuedx added a project: Test Kitchen.Jun 7 2024, 4:58 PM

• VirginiaPoundstone moved this task from Incoming to BACKLOG on the Test Kitchen board.Jun 10 2024, 3:08 PM

• VirginiaPoundstone moved this task from BACKLOG to Data Products Sprint 16 on the Test Kitchen board.Jun 21 2024, 4:05 PM

• VirginiaPoundstone edited projects, added Test Kitchen (Data Products Sprint 16); removed Test Kitchen.

cjming mentioned this in T366949: MPIC: Add stream name to forms/database/api.Jun 21 2024, 11:48 PM

• VirginiaPoundstone renamed this task from Land MR !39 to Update API to talk about Instrument Name.Jul 15 2024, 3:35 PM

• VirginiaPoundstone edited projects, added Test Kitchen (Data Products Sprint 17); removed Test Kitchen (Data Products Sprint 16).

• VirginiaPoundstone renamed this task from Update API to talk about Instrument Name to Update (the metrics platform) API to talk about Instrument Name.Jul 29 2024, 7:31 PM

• VirginiaPoundstone triaged this task as Low priority.

If we have time to get started on this in Sprint 17, great!
@phuedx has the patch ready to go (says @cjming), so it might not be much work.

Is it backward compatible? Or is it a breaking change?

If we don't get to it sprint 17, it will be a higher priority in sprint 18.

Might be interesting work for @SGupta-WMF as part of onboarding? @WDoranWMF what do you think?

phuedx renamed this task from Update (the metrics platform) API to talk about Instrument Name to Update the Metrics Platform JS Client Library API to talk about Instrument Name.Aug 6 2024, 1:01 PM

phuedx updated the task description. (Show Details)

• VirginiaPoundstone mentioned this in T372585: [Sprint 18 GOAL] MPIC Alpha: Refactor client libraries for Monotable.Aug 15 2024, 6:37 PM

• WDoranWMF moved this task from Sprint Backlog to Wormhole To Sprint 18 on the Test Kitchen (Data Products Sprint 17) board.Aug 16 2024, 4:40 PM

• WDoranWMF edited projects, added Test Kitchen (Data products Sprint 18); removed Test Kitchen (Data Products Sprint 17).

Sfaci claimed this task.Aug 20 2024, 1:19 PM

Sfaci moved this task from Sprint Backlog to In Process on the Test Kitchen (Data products Sprint 18) board.Aug 20 2024, 8:36 PM

Sfaci set the point value for this task to 8.Aug 21 2024, 12:31 PM

Sfaci changed the point value for this task from 8 to 5.