Page MenuHomePhabricator

[Metrics Platform] Standard base schema should include a 'test' or 'debug' field for QA and other purposes
Closed, ResolvedPublic

Description

As raised by @Mayakp.wiki, it would be helpful to have a field that would allow us to filter for events that were set by a QA tester. This is particularly important for events which do not include a user_id, which would otherwise be used to identify events originating from the QA tester or QA process.

Event Timeline

jlinehan raised the priority of this task from Medium to High.Oct 6 2021, 2:02 PM
DAbad moved this task from Discussed to Done on the Metrics Platform Backlog board.

Jason has confirmed fields have been added to first iteration of the schema. Closing

Mayakp.wiki added subscribers: mpopov, EChetty.

@DAbad @jlinehan Can we get more details about this field? like name, datatype, etc. ? the ideal next step would be to test this field which can be done either by
a. keeping this task open for data-qa. close once all tests are passed
b. close this one and open a subtask for data-qa

Update from @EChetty during 1:1 today - Waiting to be packaged and deployed.. ETA next week; contingent to mediawiki train schedule

Removing inactive assignee from this open task. (Please update assignees on open tasks after offboarding. Thanks.)

Mayakp.wiki added a subscriber: phuedx.

Hi @phuedx, do we have a 'test' or 'debug' field in the Event schema?
Didn't see it listed here - https://wikitech.wikimedia.org/wiki/Metrics_Platform/Event_Schema

Hi @phuedx, do we have a 'test' or 'debug' field in the Event schema?
Didn't see it listed here - https://wikitech.wikimedia.org/wiki/Metrics_Platform/Event_Schema

The mediawiki.is_debug_mode field indicates whether "the MediaWiki instance is considered to be running in debug mode." In a moment, I'll update that description to clarify that it indicates whether the MediaWiki EventLogging extension is running in debug mode.

There's some discussion in T277106: [Metrics Platform] QA/testing privleged mode: eventlogging-display-web, a QA user group, or something else? as to whether this is sufficient. If, for example, we also said that the user being in the "wmf-qa" group is an indicator, then we can use the schema's performer.groups field.

In a moment, I'll update that description to clarify that it indicates whether the MediaWiki EventLogging extension is running in debug mode.

Done in https://wikitech.wikimedia.org/w/index.php?title=Metrics_Platform%2FEvent_Schema&type=revision&diff=1999436&oldid=1951462

Thanks @phuedx for the update! It is super useful to have these QA fields. Pls feel free to let me know whenever you would like to have Product-Analytics represented in these discussions.