Log additional click events on Special:MobileDiff
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	Samwalton9-WMF
	Jan 4 2023, 12:41 PM

Description

We want to be able to log click events on actions and links of note in Special:MobileDiff so that we can better understand user behaviour on the page and evaluate our changes. This task is limited in scope to Special:MobileDiff (not the normal desktop Special:Diff page) and the MinervaNeue skin.

Specs

Thank

Previous/Next edit

Technical information

TBD

Testing and QA / Acceptance Criteria

Clicking the links highlighted above in Special:MobileDiff in the MinervaNeue skin should log an event via the Metrics Platform.

Details

Subject	Repo	Branch	Lines +/-
beta: log additional click events on Special:Diff\|MobileDiff	operations/mediawiki-config	master	+24 -1
improve diff logging instrument	mediawiki/extensions/WikimediaEvents	master	+7 -3
Log additional click events on Special:MobileDiff	mediawiki/extensions/WikimediaEvents	master	+66 -1
Log additional click events on Special:MobileDiff	operations/mediawiki-config	master	+21 -1

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T312640 Evaluate and improve diffs and undoing edits on mobile web
Resolved	Samwalton9-WMF	T326212 Improve data logging on Special:Diff and Special:MobileDiff
Resolved	jsn.sherman	T326216 Log additional click events on Special:MobileDiff

Event Timeline

Samwalton9-WMF created this task.Jan 4 2023, 12:41 PM

Restricted Application added a subscriber: Masumrezarock100. · View Herald TranscriptJan 4 2023, 12:41 PM

Samwalton9-WMF moved this task from Inbox to Diff/Undo on the Moderator-Tools-Team board.Jan 4 2023, 12:42 PM

Samwalton9-WMF moved this task from Diff/Undo to To be estimated on the Moderator-Tools-Team board.

Samwalton9-WMF updated the task description. (Show Details)Jan 9 2023, 1:23 PM

Samwalton9-WMF renamed this task from Log click events for Thanks on Special:MobileDiff to Log additional click events on Special:MobileDiff.Jan 18 2023, 10:51 AM

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

Samwalton9-WMF set the point value for this task to 3.Jan 19 2023, 3:35 PM

Samwalton9-WMF moved this task from To be estimated to Kanban on the Moderator-Tools-Team board.

Samwalton9-WMF edited projects, added Moderator-Tools-Team (Kanban); removed Moderator-Tools-Team.

jsn.sherman changed the task status from Open to In Progress.Mar 13 2023, 5:36 PM

jsn.sherman claimed this task.

jsn.sherman moved this task from Ready to In Progress on the Moderator-Tools-Team (Kanban) board.

Change 899674 had a related patch set uploaded (by Jsn.sherman; author: Jsn.sherman):

[mediawiki/extensions/WikimediaEvents@master] Log additional click events on Special:MobileDiff

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

gerritbot added a project: Patch-For-Review.Mar 15 2023, 4:37 PM

Change 899725 had a related patch set uploaded (by Jsn.sherman; author: Jsn.sherman):

[operations/mediawiki-config@master] Log additional click events on Special:MobileDiff

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

jsn.sherman moved this task from In Progress to Eng review on the Moderator-Tools-Team (Kanban) board.Mar 15 2023, 6:34 PM

Samwalton9-WMF mentioned this in T71804: Thanks: add instrumentation to Thanks.Mar 28 2023, 4:10 PM

jsn.sherman moved this task from Eng review to In Progress on the Moderator-Tools-Team (Kanban) board.Apr 24 2023, 3:13 PM

SNowick_WMF mentioned this in T335444: Get Baseline data from Android & Mobile Web for iOS Watchlist .May 16 2023, 7:12 PM

jsn.sherman moved this task from In Progress to Eng review on the Moderator-Tools-Team (Kanban) board.May 30 2023, 8:27 PM

Change 896432 had a related patch set uploaded (by Jsn.sherman; author: Jsn.sherman):

[operations/mediawiki-config@master] beta: log additional click events on Special:Diff

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

Change 899725 abandoned by Jsn.sherman:

[operations/mediawiki-config@master] Log additional click events on Special:MobileDiff

Reason:

abandoned in favor of I78f051bd9370e6c8e9b75129bfb3823dfe11d2dd

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

Change 899674 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Log additional click events on Special:MobileDiff

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

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.12; 2023-06-06).Jun 1 2023, 7:00 PM

Change 896432 merged by jenkins-bot:

[operations/mediawiki-config@master] beta: log additional click events on Special:Diff|MobileDiff

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

Maintenance_bot removed a project: Patch-For-Review.Jun 7 2023, 8:30 PM

I verified that mobile logging is working on beta:

I visited this revision:
https://en.m.wikipedia.beta.wmflabs.org/wiki/Special:MobileDiff/571317

and followed the stream topic here:
https://stream-beta.wmflabs.org/v2/ui/#/?streams=mediawiki.special_diff_interactions

{
  "$schema": "/analytics/mediawiki/client/metrics_event/1.2.0",
  "dt": "2023-06-15T13:40:19.615Z",
  "name": "specialMobileDiff.click.prev_link",
  "custom_data": {},
  "meta": {
    "stream": "mediawiki.special_diff_interactions",
    "domain": "en.wikipedia.beta.wmflabs.org",
    "id": "2a1aa7d5-f2cd-4558-816f-28109f77b27d",
    "dt": "2023-06-15T13:40:20.009Z",
    "request_id": "2b978b70-0b82-11ee-9931-897bd4c4e7d2",
    "topic": "eqiad.mediawiki.special_diff_interactions",
    "partition": 0,
    "offset": 22
  },
  "mediawiki": {
    "skin": "minerva",
    "version": "1.41.0-alpha",
    "is_production": false,
    "database": "enwiki"
  },
  "performer": {
    "is_logged_in": true,
    "groups": [
      "*",
      "user"
    ],
    "edit_count_bucket": "0 edits",
    "registration_dt": "2022-04-13T20:10:01.000Z"
  },
  "agent": {
    "client_platform": "mediawiki_js",
    "client_platform_family": "mobile_browser"
  },
  "http": {
    "request_headers": {
      "user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 Edg/114.0.1823.37"
    }
  }
}

thank

{
  "$schema": "/analytics/mediawiki/client/metrics_event/1.2.0",
  "dt": "2023-06-15T13:40:23.318Z",
  "name": "specialMobileDiff.click.thank",
  "custom_data": {},
  "meta": {
    "stream": "mediawiki.special_diff_interactions",
    "domain": "en.wikipedia.beta.wmflabs.org",
    "id": "16a760b1-9d8c-470a-bddc-e293beedde27",
    "dt": "2023-06-15T13:40:50.732Z",
    "request_id": "3de73280-0b82-11ee-9931-897bd4c4e7d2",
    "topic": "eqiad.mediawiki.special_diff_interactions",
    "partition": 0,
    "offset": 23
  },
  "mediawiki": {
    "skin": "minerva",
    "version": "1.41.0-alpha",
    "is_production": false,
    "database": "enwiki"
  },
  "performer": {
    "is_logged_in": true,
    "groups": [
      "*",
      "user"
    ],
    "edit_count_bucket": "0 edits",
    "registration_dt": "2022-04-13T20:10:01.000Z"
  },
  "agent": {
    "client_platform": "mediawiki_js",
    "client_platform_family": "mobile_browser"
  },
  "http": {
    "request_headers": {
      "user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 Edg/114.0.1823.37"
    }
  }
}

{
  "$schema": "/analytics/mediawiki/client/metrics_event/1.2.0",
  "dt": "2023-06-15T13:42:28.486Z",
  "name": "specialMobileDiff.click.next_link",
  "custom_data": {},
  "meta": {
    "stream": "mediawiki.special_diff_interactions",
    "domain": "en.wikipedia.beta.wmflabs.org",
    "id": "019ce222-0c74-4ca1-bcf1-24afba4d85e8",
    "dt": "2023-06-15T13:42:28.930Z",
    "request_id": "786f05e0-0b82-11ee-9931-897bd4c4e7d2",
    "topic": "eqiad.mediawiki.special_diff_interactions",
    "partition": 0,
    "offset": 24
  },
  "mediawiki": {
    "skin": "minerva",
    "version": "1.41.0-alpha",
    "is_production": false,
    "database": "enwiki"
  },
  "performer": {
    "is_logged_in": true,
    "groups": [
      "*",
      "user"
    ],
    "edit_count_bucket": "0 edits",
    "registration_dt": "2022-04-13T20:10:01.000Z"
  },
  "agent": {
    "client_platform": "mediawiki_js",
    "client_platform_family": "mobile_browser"
  },
  "http": {
    "request_headers": {
      "user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 Edg/114.0.1823.37"
    }
  }
}

Seeing how we get skin and client_platform_family (either mobile_browser or desktop_browser) I wonder if we actually need separate action names ( eg. specialMobileDiff.click.prev_link and specialDiff.click.prev_link ) for the two interfaces. It seems like it's not strictly necessary, but it may help make it easier to separate them in whatever interface the data folks use. I'll ping someone who is smart about the data things and see what they have to say.

@jsn.sherman I would say it's actually easier to use a single event name and use another field like client_platform_family to split it when necessary. The "split-apply-combine" strategy is very common in data analysis, so our tools generally make it easy to split when necessary (whereas combining without a previous split tends to be less ergonomic).

For example, here's how it appears in Superset, our main dashboarding tool. The "group by" function (as in an SQL GROUP BY) is the split, the "pageview" metric (which is just a sum) is the apply, and outputting a single result table which can be graphed is the combine.

Screenshot 2023-06-15 at 19.47.57.png (1×1 px, 337 KB)

The same is true in Pandas (the main Python library for data analysis): https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html

Change 930819 had a related patch set uploaded (by Jsn.sherman; author: Jsn.sherman):

[mediawiki/extensions/WikimediaEvents@master] improve diff logging instrument

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

gerritbot added a project: Patch-For-Review.Jun 16 2023, 4:18 PM

This was helpful, thanks!

In T326216#8937369, @nshahquinn-wmf wrote:

@jsn.sherman I would say it's actually easier to use a single event name and use another field like client_platform_family to split it when necessary. The "split-apply-combine" strategy is very common in data analysis, so our tools generally make it easy to split when necessary (whereas combining without a previous split tends to be less ergonomic).

For example, here's how it appears in Superset, our main dashboarding tool. The "group by" function (as in an SQL GROUP BY) is the split, the "pageview" metric (which is just a sum) is the apply, and outputting a single result table which can be graphed is the combine.

The same is true in Pandas (the main Python library for data analysis): https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html