[go: nahoru, domu]

Page MenuHomePhabricator

[SPIKE] What instrumentation is currently in place to evaluate Citoid feature use?
Closed, ResolvedPublic

Description

In T368988, we will be conducting an investigation to better understand how people are using Citoid and more broadly, the role Citoid plays within the broader set of Wikimedia editing experiences.

To enable the investigation described above, we first need to understand what Citoid-related instrumentation is currently in place?

Decisions to be made

  • What Citoid-related instrumentation is currently in place? What kinds of questions can we use this instrumentation to help us answer?
  • Of the Research questions documented in T368988, which – if any – are we NOT currently able to answer using the instrumentation that is currently in place?
    • We should be able to answer most all research questions as currently defined using existing instrumentation. I outlined events and available existing instrumentation in this spec.
  • What – if any – new instrumentation would we need to add in order o answer the the Research questions documented in T368988?
    • The only question that might require additional instrumentation is the following:

Of the citations people attempt to use Citoid to generate, what percentage of these attempts are for various content types (.mov, .pdf, url, etc.)?

Event Timeline

Below are some notes based on my initial review of existing Citoid instrumentation:

What Citoid-related instrumentation is currently in place? What kinds of questions can we use this instrumentation to help us answer?

VisualEditorFeatureUse includes a number of events that track user engagement with citoid including clicks to open the feature, generate a citation, and insert a citation. These are documented in the VEFU data dictionary and listed below:

    • Window-open-from-command to window-open-from-check: User opens citoid or it is opened after user interaction with reference check dialog.
    • automatic-generate : The "generate" button was clicked to generate a citation based on a URL (or DOI or ISBN)
    • automatic-generate-fail[1]: Automatic citation generation failed and error message is displayed.
    • automatic-generate-fail-searchResults[1]: Automatic citation generation failed because no search results were found for the provided input.
    • automatic-generate-fail-network[1]: Automatic citation generation failed due to a network error while attempting to retrieve the necessary information.
    • automatic-insert: The "insert" button was clicked to insert a Citoid-generated citation into the page
    • Panel-switch: The user switched between tabs or panes within a dialog. For example, switching between “manual” and “automatic”
    • Dialog-Manual-choose: choose to insert manual citation
    • Resuse-choose: The user selected an existing citation to insert again.
  • Note: Once a Citoid-generated reference is inserted, it becomes a normal reference and editing it would fall under cite.

[1] It looks like these three automatic-fail- events were recently instrumented by WMDE in T363292.

Other Instrumentation:

  • The logstash dashboard created in T368802 can be used to view Citoid requests over time and top requested domains. Data can be viewed by response codes so you can determine the rate at which requests are failing.
  • There's also a Citoid grafana dashboard that shows requests over time by input type and HTTP status as well as some performance tracking (latency, memory, CPU)

Of the Research questions documented in T368988, which – if any – are we NOT currently able to answer using the instrumentation that is currently in place?

We should be able to answer most all research questions as currently defined using existing instrumentation. I outlined events and available existing instrumentation in this spec.

The only question that might require additional instrumentation is the following:

Of the citations people attempt to use Citoid to generate, what percentage of these attempts are for various content types (.mov, .pdf, url, etc.)?

This is not currently instrumented. We do know the requested domains from Citoid after we get a response from the server.

Note: If we add additional user workflows to the citoid feature such as offering an action they can take from within Citoid’s error state to cite a source. We will need to add additional instrumentation to track this engagement (likely within VE).

Per what @MNeisler and I talked about offline this week, the findings Megan shared in T369663#9982261 are precisely what we needed to move forward with T368988.

Restating two resulting actions Megan named in T369663#9982261:

  1. To track measure engagement with the call to action (Add manually) T364595 introduced, we'll need new instrumentation. That instrumentation will be added in the newly-created T370561.
  2. To measure Citoid requests by content type, we'll also need new instrumentation. Tho, adding that instrumentation is blocked on T361576, as Marielle noted in T365583#9968071.

Hi from the Technical Wishes dev team. I just wanted to cross link our recent analytics work in the WMDE-References-FocusArea that's mainly around T362347: Log events for some simple interactions in the VE cite dialogs and the superset dashboard for Citoid usage at https://superset.wikimedia.org/superset/dashboard/518/?native_filters_key=o1vk2wECKCNertKma5Q5UXnFr6-cCk5e_wirjEAd01PYCOEdAadlO3IpkCtKB_OR maybe there's something of use.