Page MenuHomePhabricator

Create a data dictionary for the VisualEditorFeatureUse data stream
Closed, ResolvedPublic

Description

The VisualEditorFeatureUse schema is very permissive, consisting of the editing session ID and two unvalidated text fields. This makes it very easy to instrument for, since developer can simply log events when key UI code paths are called without having to know which exact events will result. However, this makes the data hard to analyze since the schema doesn't provide a definitive list of possible values and their meanings.

We should keep the unvalidated nature of the schema, but make a data dictionary so at least we only need to figure out the meaning of each value once.

Event Timeline

JTannerWMF subscribed.

Hey @Neil_P._Quinn_WMF can you add in the details of this and place it in the appropriate place on the board?

nshahquinn-wmf moved this task from Triage to Next Up on the Product-Analytics board.
nshahquinn-wmf renamed this task from Create a "data" dictionary for VE `feature-use` schema to Create a data dictionary for the VisualEditorFeatureUse data stream.Aug 28 2019, 7:22 PM
nshahquinn-wmf updated the task description. (Show Details)

I've started a draft in my userspace on Meta. I'm not sure where it will end up—pages in the Schema namespace need to be JSON, and pages in the Schema Talk namespace can't use VE.

The permanent home is mw:VisualEditor/FeatureUse data dictionary.

I've filled in the key parts of the table. Of the parts that are still blank, some are self-explanatory; the parts I was confused about are marked with ??.