Page MenuHomePhabricator

Implement the instrumentation to track usage of MinT in the Translate extension
Open, In Progress, MediumPublic8 Estimated Story Points

Description

As part of the work to track the usage of MinT in the Translate extension (T350483), this ticket focuses on implementing the schema defined (T362750).

Event Timeline

Change #1062367 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/TranslationNotifications@master] NotificationMessageBuilder: add `action_source` query param

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

Change #1046661 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] MinT: Add event logging to Translate

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

Change #1062367 merged by jenkins-bot:

[mediawiki/extensions/TranslationNotifications@master] NotificationMessageBuilder: add `action_source` query param

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

Change #1046661 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] MVP: Add event logging to Special:Translate

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

T369687 has been resolved. Following this comment, we should now be able to proceed with implementing a number of other events that would eventually lead to a holistic picture when tracking usage of MinT in the Translate extension.

As a caveat, it was pointed out that a number of events and the related work items around them may not directly point at MinT instrumentation, though related. I think this is fine as long as it serves the end goal. There's a new configuration parameter, TranslateEnableEventLogging, that is disabled by default on wikis that have the Translate Extension installed. I expect another configuration parameter that is specific to MinT in upcoming patches.

@Wangombe

T369687 has been resolved. Following this comment, we should now be able to proceed with implementing a number of other events that would eventually lead to a holistic picture when tracking usage of MinT in the Translate extension.

Yes, I have added a couple of columns to the schema (E & F) with information about what needs to changed from action_context to the schema fragment fields.

As a caveat, it was pointed out that a number of events and the related work items around them may not directly point at MinT instrumentation, though related. I think this is fine as long as it serves the end goal.

Yes, I think at this point the schema is more for the Translate extension, rather than specifically MinT only, as some of other events will have to be tracked for us to get a better understanding of the user interactions.


A quick note (after I heard back from the Metrics Platform team), all events should have the translation object. If an event is not using any of the translation fields, it can be an empty object {}. This will ensure that those events pass EventGate validation.

Change #1078542 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] Event Logging: Add 'message_prompt' action

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

Change #1078615 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] Event Logging: Add 'switch_translate_content' action

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

Change #1079806 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] TUX event logging: User closes the translation editor

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

Change #1079807 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] TUX event logging: User copies source text

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

Change #1082692 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] Event Logging: Add 'review' action

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

Change #1082726 had a related patch set uploaded (by Wangombe; author: Wangombe):

[operations/mediawiki-config@master] Translate Event Logging: Enable using $wgTranslateEnableEventLogging

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

Change #1084043 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] Event Logging: Translation editor of a message is opened

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

Change #1079807 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] TUX event logging: User copies source text

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

Change #1085263 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] TUX event logging: User changes the translation view/mode

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

Change #1085309 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] TUX event logger: User pastes the text

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

Change #1085309 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] Event Logging: User pastes the text

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

Change #1079806 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] Event Logging: User closes the translation editor

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

Change #1082692 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] Event Logging: Add 'review' action

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

Change #1085263 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] Event Logging: User changes the translation view/mode

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

Change #1082726 merged by jenkins-bot:

[operations/mediawiki-config@master] Translate Event Logging: Enable using $wgTranslateEnableEventLogging

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

Mentioned in SAL (#wikimedia-operations) [2024-11-19T08:04:34Z] <urbanecm@deploy2002> Started scap sync-world: Backport for [[gerrit:1082726|Translate Event Logging: Enable using $wgTranslateEnableEventLogging (T364460)]], [[gerrit:1092258|CirrusSearch: enable offloading weighted tags via EventBus (T378983 T377150)]], [[gerrit:1091197|[GrowthExperiments] Add virtual domain config (T354939)]]

Mentioned in SAL (#wikimedia-operations) [2024-11-19T08:12:12Z] <urbanecm@deploy2002> urbanecm, wangombe, pfischer: Backport for [[gerrit:1082726|Translate Event Logging: Enable using $wgTranslateEnableEventLogging (T364460)]], [[gerrit:1092258|CirrusSearch: enable offloading weighted tags via EventBus (T378983 T377150)]], [[gerrit:1091197|[GrowthExperiments] Add virtual domain config (T354939)]] synced to the testservers (https://wikitech.wikimedia.org/wiki/Mwdebug)

Mentioned in SAL (#wikimedia-operations) [2024-11-19T08:29:16Z] <urbanecm@deploy2002> Finished scap sync-world: Backport for [[gerrit:1082726|Translate Event Logging: Enable using $wgTranslateEnableEventLogging (T364460)]], [[gerrit:1092258|CirrusSearch: enable offloading weighted tags via EventBus (T378983 T377150)]], [[gerrit:1091197|[GrowthExperiments] Add virtual domain config (T354939)]] (duration: 24m 42s)

Change #1092915 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] Event Logging: A translation suggestion is shown to the user [DNM}

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

Change #1092921 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] Event Logging: User accepts a translation suggestion[DNM]

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

Change #1094375 had a related patch set uploaded (by Wangombe; author: Wangombe):

[mediawiki/extensions/Translate@master] Event Logging: User exits the translation dashboard

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