Add geolocation information to EditAttemptStep
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	MNeisler
	Jul 29 2022, 7:20 PM

Description

The Editing team would like to add geolocation data to the EditAttemptStep schema (This was removed as part fo the migration process for legacy schemas in T262626 and never added to the Event Platform schemas).

This data is needed to complete several planned analyses for the upcoming fiscal year where we would like to know the geolocation information (country and region) of editors that attempt but never complete an edit.

Implementation details

Per details I found in a similar task (T287121#7229889), this will require adding the http.client_ip field to the schema. EventGate will then automatically populate it. See more details in https://wikitech.wikimedia.org/wiki/Event_Platform/Schemas/Guidelines#http_information

Done

Patch is created and merged to add http.client_ip field back to EditAttemptStep
@MNeisler reviews aggregate data in EditAttemptStep once deployed to confirm it is working

Details

	Subject	Repo	Branch	Lines +/-
	Bump EditAttemptStep schema version	mediawiki/extensions/WikimediaEvents	master	+1 -1
	Include client_ip in EditAttemptStep schema	schemas/event/secondary	master	+577 -3

Customize query in gerrit

Related Objects

Mentioned In: T355922: WikiLambda metrics: Consider adding geo-data to create/edit tracking events
T317825: Enable "Sub-Saharan Africa editors by user agent" superset dashboard to update itself automatically
T314202: [SPIKE] What devices, browsers, OSes, etc. are volunteers from Sub-Saharan Africa using to edit Wikipedia
T314548: [SPIKE] Generate a list of the usernames of people who are editing Wikipedia from Sub-Saharan Africa
Mentioned Here: T310390: Instrument blocked edit attempts
T262626: Remove http.client_ip from EventGate default schema (again)
T287121: Add geolocation information to Growth schemas

Event Timeline

MNeisler created this task.Jul 29 2022, 7:20 PM

MNeisler moved this task from Triage to Tracking on the Product-Analytics board.

ppelberg edited projects, added Goal, Editing-team (Kanban Board); removed Editing-team.Aug 3 2022, 8:15 PM

ppelberg moved this task from Incoming to Ready to Be Worked On on the Editing-team (Kanban Board) board.Aug 5 2022, 5:22 PM

MNeisler mentioned this in T314548: [SPIKE] Generate a list of the usernames of people who are editing Wikipedia from Sub-Saharan Africa.Sep 7 2022, 6:17 PM

MNeisler mentioned this in T314202: [SPIKE] What devices, browsers, OSes, etc. are volunteers from Sub-Saharan Africa using to edit Wikipedia.Sep 14 2022, 2:26 PM

ppelberg mentioned this in T317825: Enable "Sub-Saharan Africa editors by user agent" superset dashboard to update itself automatically .Sep 21 2022, 8:18 PM

I wound up doing this for a different schema in T310390, so assuming that data comes out correctly I do know what's needed now.

Change 842452 had a related patch set uploaded (by DLynch; author: DLynch):

[schemas/event/secondary@master] Include client_ip in EditAttemptStep schema

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

gerritbot added a project: Patch-For-Review.Oct 13 2022, 1:48 PM

DLynch claimed this task.Oct 13 2022, 2:02 PM

DLynch moved this task from Ready to Be Worked On to Code Review on the Editing-team (Kanban Board) board.

Change 842490 had a related patch set uploaded (by DLynch; author: DLynch):

[mediawiki/extensions/WikimediaEvents@master] Bump EditAttemptStep schema version

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

Change 842452 merged by jenkins-bot:

[schemas/event/secondary@master] Include client_ip in EditAttemptStep schema

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

Change 842490 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Bump EditAttemptStep schema version

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

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.6; 2022-10-17).Oct 17 2022, 8:00 AM

Maintenance_bot removed a project: Patch-For-Review.Oct 17 2022, 8:30 AM

This needs to be checked up on by Megan, as it's 100% on "is the correct data being stored now?"

MNeisler triaged this task as Medium priority.Oct 21 2022, 2:24 PM

MNeisler edited projects, added Product-Analytics (Kanban); removed Product-Analytics.

MNeisler moved this task from Next 2 weeks to Doing on the Product-Analytics (Kanban) board.Oct 25 2022, 8:31 PM

I reviewed the aggregate data and confirmed that the recently added geolocation data and are logged and stored as expected in EditAttemptStep. All edit attempts now have an associated county, continent, and country code that can be accessed using the geocoded_data field.

We start fully logging this data on 18 October 2022.

@ppelberg - Reassigning to you for sign-off

ppelberg closed this task as Resolved.Oct 26 2022, 8:11 PM

DMartin-WMF mentioned this in T355922: WikiLambda metrics: Consider adding geo-data to create/edit tracking events.Jan 31 2024, 7:08 PM

Add geolocation information to EditAttemptStepClosed, ResolvedPublicActions