Page MenuHomePhabricator

Log when a user interacts with the inline help in the infobox
Closed, ResolvedPublic2 Estimated Story Points

Description

Background

Following on from T296415: Basic ipinfo instrument setup and first events, we'd like to know when the user interacts with the inline help in the infobox and which items they most frequently interact with.

This task is distinct from the task above as it's blocked on T271672: Add help text for Connection Method and Connection Owner in IPInfo infobox [M].

AC
  • When I click the ? button next to an IP address, an event should be logged
    • The event_action property should be

click_help_connection_method
click_help_connection_owner
click_help_proxy

  • The event_context property should be "infobox"
  • The event_source Should be special_contributions
Notes
  1. See the current.yaml files in the subdirectories in https://gerrit.wikimedia.org/r/plugins/gitiles/schemas/event/secondary/+/refs/heads/master/jsonschema/analytics/mediawiki for numerous examples of JSON Schema schemas that are used in production
  2. wt:Event Platform/Instrumentation How To is a step-by-step guide to creating a creating a schema and validating an event with it
  3. https://www.mediawiki.org/wiki/MediaWiki-Docker/Configuration_recipes/EventLogging is a step-by-step guide to setting up your local development environment

Event Timeline

ARamirez_WMF renamed this task from Log when a user interacts with the inline help in the infobox to Log when a user interacts with the inline help in the infobox [S].Nov 30 2021, 5:38 PM
ARamirez_WMF renamed this task from Log when a user interacts with the inline help in the infobox [S] to Log when a user interacts with the inline help in the infobox.Feb 15 2022, 6:49 PM
ARamirez_WMF set the point value for this task to 2.

Change 771377 had a related patch set uploaded (by AGueyte; author: AGueyte):

[mediawiki/extensions/IPInfo@master] log when user click helpline

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

Tchanders added a subscriber: Tchanders.
  • The event_context property should be "infobox"
  • The event_source property should be a machine-readable name of the line item that the user is getting help for

@Niharika For other events, event_context is the feature the user is interacting with e.g.:

- page
- infobox
- popup
- ip_address

...and event_source is the page that the event is taking place on, i.e. one of:

- action_history
- special_log
- special_recentchanges
- special_contributions
- special_preferences

Given this, would it make more sense for the machine-readable name of the line item that the user is getting help for to be recorded as the event_context rather than the event_source?

  • The event_context property should be "infobox"
  • The event_source property should be a machine-readable name of the line item that the user is getting help for

@Niharika For other events, event_context is the feature the user is interacting with e.g.:

- page
- infobox
- popup
- ip_address

...and event_source is the page that the event is taking place on, i.e. one of:

- action_history
- special_log
- special_recentchanges
- special_contributions
- special_preferences

Given this, would it make more sense for the machine-readable name of the line item that the user is getting help for to be recorded as the event_context rather than the event_source?

Pinging also @jwang for your thoughts on the above

  • The event_context property should be "infobox"
  • The event_source property should be a machine-readable name of the line item that the user is getting help for

@Niharika For other events, event_context is the feature the user is interacting with e.g.:

- page
- infobox
- popup
- ip_address

...and event_source is the page that the event is taking place on, i.e. one of:

- action_history
- special_log
- special_recentchanges
- special_contributions
- special_preferences

Given this, would it make more sense for the machine-readable name of the line item that the user is getting help for to be recorded as the event_context rather than the event_source?

Pinging also @jwang for your thoughts on the above

We could also update the event actions list as follow:

  • click_help_connection_method
  • click_help_connection_owner
  • click_help_proxy

Thanks for pinging me. Are we discussing the instrumentation for below interface?

image.png (556ร—1 px, 132 KB)

Does below proposal make sense to you?
event_action

  • click_help_connection_method
  • click_help_connection_owner
  • click_help_proxy
  • click_help_static

event_context (what the clicks for)

  • infobox

event_source (where the clicks from)

  • ip_information

Thanks @jwang, that sounds good! Just one question:

event_source (where the clicks from)

  • ip_information

For the other events, event_source is the page name, so would it be ok to put special_contributions here? (That interface is always on the Special:Contributions page)

For the other events, event_source is the page name, so would it be ok to put special_contributions here? (That interface is always on the Special:Contributions page)

Sounds good to me. Thanks.

NB the screenshot in T296428#7805166 is old, so we won't need:

  • click_help_static

Change 774980 had a related patch set uploaded (by AGueyte; author: AGueyte):

[schemas/event/secondary@master] Add new event action

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

Change 774980 merged by jenkins-bot:

[schemas/event/secondary@master] Add new event action

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

Change 771377 merged by jenkins-bot:

[mediawiki/extensions/IPInfo@master] Log the infobox inline help click event

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