Page MenuHomePhabricator

Revise Tone: Performance metrics are collected
Closed, ResolvedPublic3 Estimated Story Points

Description

In addition to tracking the detailed analytics needed for evaluating the A/B test (T405177), we also want engineering focused performance metrics to be able to assert that our feature works as expected on a technical level.

This explicitly includes tracking the runtime needed to figure out for which paragraph to show the Revise Tone Check. (See the internal slack conversation for context.)

Acceptance Criteria:
Metrics for at least the following are being recorded:

  • time to get data from Data Gateway
  • time to get find correct paragraph in article
  • number of users declining a task with which reason in the survey
  • number of errors
    • suggestion no longer available (no data in data gateway)
    • paragraph ambiguous (distance of 2nd-highest scoring paragraph is 90% of the distance of the 2nd-highest scoring paragraph)

In addition to the above, we should make sure that the ReviseTone task is visible on the KPI dashboard next to the other Newcomer Tasks

  • ReviseTone will be visible on the KPI dashboard

Notes:

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript
KStoller-WMF moved this task from Inbox to Needs Estimation on the Growth-Team board.
Michael renamed this task from Revise Tone: Performance metrics are collected and visualized to Revise Tone: Performance metrics are collected.Nov 3 2025, 5:01 PM
Michael updated the task description. (Show Details)
KStoller-WMF lowered the priority of this task from High to Medium.Nov 4 2025, 4:59 PM
KStoller-WMF set the point value for this task to 3.Dec 1 2025, 5:22 PM

Change #1215246 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/GrowthExperiments@master] metrics(ReviseTone): record the time to match the paragraph

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

I extended the definition of the task type variable on the KPI dashboard to include revise_tone.

Change #1215246 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] metrics(ReviseTone): record the time to match the paragraph

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

Change #1217486 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/GrowthExperiments@master] metrics(ReviseTone): track distance of paragraph match

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

Change #1219183 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/GrowthExperiments@master] metrics(ReviseTone): record platform for Levenshtein performance

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

Change #1219176 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/GrowthExperiments@master] metrics(ReviseTone): track quiz responses

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

Change #1219176 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] metrics(ReviseTone): track quiz responses

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

Change #1219183 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] metrics(ReviseTone): record platform for Levenshtein performance

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

Change #1233240 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/GrowthExperiments@master] stats(ReviseTone): count clicks to retake the onboarding quiz

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

Change #1233248 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/GrowthExperiments@master] stats(ReviseTone): Record language for quiz responses

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

@Michael - We reviewed the Revise Tone dashboard in our weekly Ambassador meeting, and @Dyolf77_WMF asked if it's possible to filter by wiki.

That would be ideal, especially since there is a chance that translations impact quiz understanding. Is that an easy addition, impossible, or possible but enough work that I should create a new task to support this request.

Also, we still haven't seen any new arwiki edits, so it would be good to understand if we have any quiz clicks on arwiki.

@Michael - We reviewed the Revise Tone dashboard in our weekly Ambassador meeting, and @Dyolf77_WMF asked if it's possible to filter by wiki.

That would be ideal, especially since there is a chance that translations impact quiz understanding. Is that an easy addition, impossible, or possible but enough work that I should create a new task to support this request.

Also, we still haven't seen any new arwiki edits, so it would be good to understand if we have any quiz clicks on arwiki.

One of the changes that I have added to this task yesterday is about collecting exactly that data! Once it has been merged and deployed (which might still be a while), we can look into adjusting the dashboard to see what is going on.

Change #1217486 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] metrics(ReviseTone): track distance of paragraph match and ambiguity

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

Change #1233240 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] stats(ReviseTone): count clicks to retake the onboarding quiz

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

Change #1233248 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] stats(ReviseTone): Record language for quiz responses

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

Change #1235097 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/GrowthExperiments@master] fix(ReviseTone): use correct stats metrics name

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

Change #1235097 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] fix(ReviseTone): use correct stats metrics name

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

Michael moved this task from Doing to Code Review on the Growth-Team (FY2025-26 Q3 Sprint 3) board.

I think this dashboard now contains all the data that we have in Prometheus for Revise Tone: https://grafana.wikimedia.org/d/0352e22b-1ebf-4e13-a97d-4f5f05eb8463/revise-tone-structured-task

Please have a look and let me know if anything is unclear or could be done better!

I'm so glad we have easy access to the quiz data, thank you for prepping this dashboard!

"Number of clicks to retake the onboarding quiz on platform" <--- Does that refer to when a user opens the help panel and clicks into the onboarding quiz again?

I'm so glad we have easy access to the quiz data, thank you for prepping this dashboard!

"Number of clicks to retake the onboarding quiz on platform" <--- Does that refer to when a user opens the help panel and clicks into the onboarding quiz again?

Yes, exactly! I'll add a note to it.