ReadingList JS instrumentation spike
Closed, ResolvedPublic2 Estimated Story PointsSpike
Actions

Assigned To

Authored By

	SToyofuku-WMF
	Aug 26 2025, 4:42 PM

Description

Proof of concept that shows what instrumentation would look for a single click event and page load event

User story

As an Engineer on the REx team, I want to know how instrumentation for click and page load events works within the new metrics platform

Requirements

Screenshot 2025-08-19 at 1.15.13 PM.png (708×652 px, 379 KB)

Whenever someone clicks the bookmark icon, we want to log a click event containing.

User flow

A user is bucketed into the experiment
An eventLogging page_load event is logged whenever they visit a page
They save or remove an article
An eventLogging click event is logged

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	POC Instrument ClickThroughRate and page load	mediawiki/extensions/WikimediaEvents	master	+33 -1

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Resolved	Spike	Jdrewniak	T402946 ReadingList JS instrumentation spike
Resolved	Spike	LMora-WMF	T403636 Instrument ReadingList click event and page load
Stalled	Goal	None	T402210 [Epic] Reading Lists - Click tracking (JS) instrumentation
Resolved		SToyofuku-WMF	T404125 Reading Lists - Begin Instrumentation
Open		None	T404788 Desktop/Mobile web Reading List A/B: Remove experiment code
Resolved		SToyofuku-WMF	T405002 Reading Lists Instrumentation - view article click event
Resolved		aude	T404999 Reading Lists Instrumentation - Contextual Attributes - Create Stream
Resolved		Jdrewniak	T405001 Reading Lists Instrumentation - "article saved" popup
Resolved		SToyofuku-WMF	T406930 QA full instrumentation for Reading List experiment

Event Timeline

SToyofuku-WMF created this task.Aug 26 2025, 4:42 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 26 2025, 4:42 PM

SToyofuku-WMF triaged this task as High priority.Aug 26 2025, 4:43 PM

SToyofuku-WMF moved this task from Incoming to Ready for sprint on the Reader Experience Team board.

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

SToyofuku-WMF edited projects, added Reader Experience Team (REx Sprint 4 [Q1 Aug 26-Sept 8 '25]); removed Reader Experience Team.

LMora-WMF claimed this task.Aug 26 2025, 6:55 PM

LMora-WMF moved this task from Ready to In progress on the Reader Experience Team (REx Sprint 4 [Q1 Aug 26-Sept 8 '25]) board.

Change #1182650 had a related patch set uploaded (by LorenMora; author: LorenMora):

[mediawiki/extensions/WikimediaEvents@master] POC Instrument ClickThroughRate and page load

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

gerritbot added a project: Patch-For-Review.Aug 27 2025, 8:18 PM

LMora-WMF renamed this task from Placeholder for JS instrumentation spike to ReadingList JS instrumentation spike .Aug 29 2025, 5:59 PM

LMora-WMF updated the task description. (Show Details)

Got a working POC patch up, here's some of the event info I am seeing:

{
    "action": "page_visited",
    "action_source": "page_load",
    "action_context": "/wiki/Main_Page",
    "experiment": {
        "enrolled": "we-3-3-4-reading-list-test1",
        "assigned": "treatment",
        "subject_id": "awaiting",
        "sampling_unit": "edge-unique",
        "coordinator": "xLab"
    },
    "$schema": "/analytics/product_metrics/web/base/1.4.2",
    "mediawiki": {
        "database": "my_wiki",
        "skin": "vector-2022"
    },
    "page": {
        "id": 15580374,
        "title": "Main Page",
        "namespace_id": 0,
        "content_language": "en"
    },
}

and similar for impression and click

{
    "action": "click",
    "instrument_name": "ClickThroughRateInstrument",
    "funnel_entry_token": "xxxxxxxxx",
    "element_friendly_name": "Save to Reading List",
    "experiment": {
        "enrolled": "we-3-3-4-reading-list-test1",
        "assigned": "treatment",
        "subject_id": "awaiting",
        "sampling_unit": "edge-unique",
        "coordinator": "xLab"
    },
}

LMora-WMF moved this task from In progress to Needs code review on the Reader Experience Team (REx Sprint 4 [Q1 Aug 26-Sept 8 '25]) board.Aug 29 2025, 6:08 PM

SToyofuku-WMF awarded a token.Aug 29 2025, 6:14 PM

In addition to celebrating the quick turnaround ^ I can also certify that this looks reasonable, makes sense, and unblocks us from implementing JS instrumentation - thanks @LMora-WMF!!

LMora-WMF added a subtask: T403636: Instrument ReadingList click event and page load.Sep 3 2025, 3:54 PM

LMora-WMF moved this task from Needs code review to Sign-off on the Reader Experience Team (REx Sprint 4 [Q1 Aug 26-Sept 8 '25]) board.

Jdrewniak added a project: FY25-26 WE3.3.4 Reading List Experiment & Rollout.Sep 3 2025, 4:59 PM

LMora-WMF closed subtask T403636: Instrument ReadingList click event and page load as Resolved.Sep 3 2025, 6:25 PM

aude mentioned this in T402210: [Epic] Reading Lists - Click tracking (JS) instrumentation.Sep 3 2025, 8:57 PM

Jdlrobson-WMF reassigned this task from LMora-WMF to Jdrewniak.Sep 9 2025, 9:37 PM

Jdlrobson-WMF added a subscriber: LMora-WMF.

Jdrewniak attached a referenced file: F65790231: Screenshot 2025-08-19 at 1.15.13 PM.png. (Show Details)Sep 9 2025, 10:21 PM

The POC looks good, it looks like we'll be able to use the CTR (click through rate) instrument for all the usage metrics we need for this experiment, and pageload event looks good too.

Jdlrobson-WMF added a project: Spike.Sep 12 2025, 8:08 PM

Restricted Application changed the subtype of this task from "Task" to "Spike". · View Herald TranscriptSep 12 2025, 8:08 PM

Change #1182650 abandoned by LorenMora:

[mediawiki/extensions/WikimediaEvents@master] POC Instrument ClickThroughRate and page load

Reason:

was just for poc