Page MenuHomePhabricator

Editor Analytics Service
Closed, ResolvedPublic

Description

The Editor Analytics service implements a subset of the AQS 2.0 endpoints, as detailed here.

NOTE: This API uses a Druid back-end.

See: https://wikitech.wikimedia.org/wiki/Analytics/AQS/Wikistats_2

The Druid-based AQS 2.0 endpoints are broken into into two services:

  • Editor Analytics
  • Edit Analytics

Certain code related to Druid queries is very similar between the two services, and should be implemented in a reusable package.

The "reusable package" will contain (at least):

  • two common query functions, to reduce code duplication. These will fill a similar need as the AQS revisions/digests functionality.
  • any other common druid-specific helper function we find useful, covering similar functionality as the existing druidUtil.js
  • any common schema definitions that we find convenient, filling similar functionality as the existing mediawiki-history-schemas.yaml. We already have a pattern (used in our service config) for importing yaml info into the Go service, so we may choose to continue using yaml for schema info.

This means the Druid-based endpoints will be divided as follows:

Editor Analyticsmetrics/editors/, metrics/registered_users/
Edit Analyticsmetrics/edits/, metrics/bytes_difference/, metrics/edited_pages/

Key tasks

Related Objects

StatusSubtypeAssignedTask
StalledNone
In ProgressNone
In ProgressDAbad
ResolvedNone
ResolvedEChukwukere-WMF
ResolvedEChukwukere-WMF
ResolvedVirginiaPoundstone
ResolvedNone
ResolvedSfaci
Resolvedhnowlan
Duplicatehnowlan
ResolvedVirginiaPoundstone
ResolvedVirginiaPoundstone
Resolvedphuedx
Resolvedhnowlan
ResolvedEChukwukere-WMF
ResolvedEChukwukere-WMF
ResolvedEChukwukere-WMF
ResolvedEChukwukere-WMF
ResolvedEChukwukere-WMF
ResolvedEChukwukere-WMF
ResolvedEChukwukere-WMF
ResolvedEChukwukere-WMF

Event Timeline

See T288301: AQS 2.0:Wikistats 2 service for discussion on why we decided to break up the AQS 2.0 Druid-based endpoints in this particular way.

See T311190: Establish testing procedure for Druid-based endpoints and T317803: AQS 2.0: Extract production testing data for Druid-based endpoints for discussion on the related testing environment.

JArguello-WMF updated the task description. (Show Details)
JArguello-WMF moved this task from Up Next to In Progress on the API Platform (AQS 2.0 Roadmap) board.
JArguello-WMF added a subscriber: hnowlan.
Sfaci changed the status of subtask T327838: AQS 2.0: Editor Analytics: Create OpenAPI Spec from In Progress to Open.
Sfaci removed Sfaci as the assignee of this task.Sep 28 2023, 3:21 PM
Sfaci subscribed.