Page MenuHomePhabricator
Create Task
Maniphest T408059

[GOAL] Tidy up EventLogging
Open, Needs TriagePublic
Actions

Description

EventLogging was the home for all code related to analytics instrumentation at WMF. It contains code relating to:

  • The so-called Legacy EventLogging system, which was superseded by the Event Platform fully in FY 24/25
  • The validation of JSONSchema schemata, whereas MediaWiki Core and very nearly all other all extensions use the justin-rainbow/json-schema or opis/json-schema libraries
  • Early attempts to introduce higher-level concepts, e.g. the mw.eventLog.Schema class
  • The Metrics Platform, including deprecated and soon-to-be-deprecated methods like mw.eventLog.dispatch() and mw.eventLog.newInstrument()

Tidying up EventLogging will help to clarify its purpose and its relationship to the Event Platform, the Metrics Platform, and Experimentation Lab.

Related Objects
Search...

StatusSubtypeAssignedTask
 OpenNoneT408059 [GOAL] Tidy up EventLogging
 OpenNoneT317874 [EPIC] Deprecate mw.eventLog.logEvent()
 ResolvedphuedxT317525 Decommission the ChangesListFilterGrouping instrument
 ResolvedphuedxT316229 Decommission the ContentTranslation instruments using legacy EventLogging schemas
 OpenNoneT305491 Deprecate/delete the mw.eventLog.Schema class
 OpenNoneT317793 [EPIC] Deprecate EventLogging::schemaValidate()
 OpenNoneT318263 [EPIC] Deprecate EventLogging::logEvent()
 ResolvedphuedxT397611 Decommission the TwoColConflictConflict and -Exit instruments
 ResolvedphuedxT352969 Deprecate and remove MetricsClient#dispatch()
 InvalidSGupta-WMFT352869 Migrate SpecialDiff instrument to use submitClick()
 ResolvedSfaciT350497 Update the WikiLambda instrumentation to use core interaction events
 ResolvedphuedxT355438 Remove the Wikilambda monoschema instrument and its configuration
 ResolvedphuedxT351335 Remove partial migration of EditAttemptStep instrument
 ResolvedSfaciT351337 Remove partial migration of VisualEditorFeatureUse instrument
 ResolvedFrostlyT354419 Remove EventLogging::submitMetricsEvent()
 ResolvedBUG REPORTphuedxT353366 Remove WikimediaEvents diff instrumentation
 ResolvedSfaciT354822 [JS] Remove dispatch method
 ResolvedphuedxT354823 [PHP] Remove dispatch method
 ResolvedphuedxT354821 Remove events key from Metrics Platform stream configs
 ResolvedcjmingT354819 [Java] Refactor api submit methods to require stream name
 ResolvedphuedxT355045 Update JS and PHP Metrics Platform Client consistency tests
 ResolvedSpikephuedxT355046 [SPIKE] Remove mentions of MetricsClient#dispatch() and the monoschema from documentation
 OpenNoneT408091 [EPIC] Deprecate and remove mw.eventLog.newInstrument()
 OpenNoneT408093 Mark mw.eventLog.newInstrument() as deprecated
 ResolvedphuedxT408094 Decouple mw.xLab.getInstrument() and mw.eventLog.newInstrument()
 OpenNoneT408097 Remove mw.eventLog.newInstrument()
 ResolvedphuedxT414218 Remove mw.eventLog.newInstrument() call from ClickThroughRateInstrument
 OpenKReid-WMFT414572 Migrate all instruments using mw.eventLog.newInstrument to mw.testKitchen.getInstrument()
 ResolvedphuedxT408096 Migrate 1 instrument using mw.eventLog.newInstrument() to mw.xLab.getInstrument()
 OpenNoneT408177 [EPIC] Deprecate and remove mw.eventLog.id
 ResolvedphuedxT408178 Decommission the Wikistories instruments
 OpenNoneT408179 Remove mw.eventLog.id
 DeclinedNoneT313784 Document the mw.eventLog.id API
 OpenNoneT384687 Send analytics events immediately
 ResolvedcjmingT417143 Synthetic experiment to test new event path (round 3)
 ResolvedKReid-WMFT417068 Synthetic experiment to test new event path (round 2)
 ResolvedSfaciT415210 Deprecate and remove mw.eventLog.submitClick()
 OpenNoneT415246 Deprecate and remove EventLogging::getMetricsPlatformClient()
 OpenSfaciT415254 Migrate "WikiLambda API" instrument to use the Test Kitchen SDK
 OpenNoneT415362 Deprecate and remove mw.eventLog.submitInteraction()
 OpenNoneT415370 Migrate all instruments using mw.eventLog.submitInteraction to mw.testKitchen.getInstrument()
 OpenNoneT416020 Deprecate and remove EventLogging.MetricsClientFactory service
 OpenNoneT415650 Migrate ReportIncident PHP instrument to use Test Kitchen SDK
 OpenNoneT415654 Migrate CheckUser PHP instrument to use Test Kitchen SDK
 OpenNoneT416021 Migrate CreateAccount PHP instrument (from WikimediaEvents) to use TestKitchen SDK
 OpenNoneT417584 Deprecate and remove/reintegrate the ext.eventLogging.metricsPlatform
 ResolvedphuedxT415579 Migrate JS and PHP client libraries to TestKitchen extension
 ResolvedSfaciT409913 Create PHP equivalent of mw.testKitchen.getInstrument()
 ResolvedphuedxT367034 TestKitchen Extension: Merge PHP MetricsPlatform client library

Event Timeline

phuedx created this task.Oct 23 2025, 5:27 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 23 2025, 5:27 AM
phuedx added a subtask: T317874: [EPIC] Deprecate mw.eventLog.logEvent().Oct 23 2025, 5:28 AM
phuedx added a subtask: T317793: [EPIC] Deprecate EventLogging::schemaValidate().Oct 23 2025, 5:32 AM
phuedx added subtasks: T318263: [EPIC] Deprecate EventLogging::logEvent(), T352969: Deprecate and remove MetricsClient#dispatch().Oct 23 2025, 5:34 AM
phuedx added a subtask: T367034: TestKitchen Extension: Merge PHP MetricsPlatform client library.Oct 23 2025, 5:52 AM
phuedx updated the task description. (Show Details)Oct 23 2025, 11:37 AM
JVanderhoop-WMF mentioned this in T384687: Send analytics events immediately.Oct 28 2025, 4:50 PM
JVanderhoop-WMF moved this task from Incoming to Tidy up EventLogging on the Test Kitchen board.Oct 28 2025, 10:02 PM
JVanderhoop-WMF added a project: Essential-Work.Oct 28 2025, 10:08 PM
phuedx added a subtask: T384687: Send analytics events immediately.Nov 3 2025, 12:44 PM
phuedx closed subtask T352969: Deprecate and remove MetricsClient#dispatch() as Resolved.Dec 5 2025, 4:56 PM
Restricted Application added a project: Data-Engineering. · View Herald TranscriptDec 5 2025, 4:56 PM
Sfaci mentioned this in T407810: Rename Client Libraries.Dec 22 2025, 2:00 PM
Sfaci mentioned this in T415210: Deprecate and remove mw.eventLog.submitClick().Jan 21 2026, 5:02 PM
Sfaci added a subtask: T415210: Deprecate and remove mw.eventLog.submitClick().
cjming subscribed.EditedJan 21 2026, 8:54 PM

just to be crystal about what is being deprecated/removed from EventLogging, are we agreeing the following will be targeted?

?

Assuming of course production code is migrated off these and corresponding/alternative methods are available in Test Kitchen.

Sfaci subscribed.Jan 22 2026, 12:34 AM
In T408059#11543345, @cjming wrote:

just to be crystal about what is being deprecated/removed from EventLogging, are we agreeing the following will be targeted?

?

Assuming of course production code is migrated off these and corresponding/alternative methods are available in Test Kitchen.

I would say it's a good summary! Just a couple of comments:

/modules/ext.eventLogging/EventSubmitter.js - related ticket T375749: Migrate EventLogging to use DefaultEventSubmitter

My understanding in this case is that EventLogging should use DefaultEventSubmitter as a replacement for the EventSubmitter that is using right now but that code would stay in EventLogging. We mentioned that TestKitchen could be using EventLogging just as an "EventGate" client, right? That case I guess that EventLogging would still need DefaultEventSubmitter. But I guess that we would remove MetricsClient anyway (we could send events directly via a DefaultEventSubmitter object as Sam's patch is already doing). In fact we are already using DefaultEventSubmitter when sending events with experiments but instruments are still using just the current EventLogging.EventSubmmiter via MetricsClient (except the ones created via mw.tk.getInstrument, that ones are already using DefaultEventSubmitter)

mw.eventLog.submitInteraction

I also assume that we should migrate this same way we want to migrate mw.eventLog.newInstrument (both functions are very similar). I'm already working on filing a ticket to cover that work (a different one than the other about migrating mw.eventLog.newInstrument()

I would also add that we would remove the lib/metrics-platform folder from EventLogging (the folder we add as foreign resources as part of the JS client library)

phuedx created subtask T415246: Deprecate and remove EventLogging::getMetricsPlatformClient().Jan 22 2026, 10:45 AM
In T408059#11543345, @cjming wrote:

Nice catch. This is covered by T415246: Deprecate and remove EventLogging::getMetricsPlatformClient().

phuedx removed a subtask: T367034: TestKitchen Extension: Merge PHP MetricsPlatform client library.Jan 22 2026, 1:02 PM
Sfaci mentioned this in T415362: Deprecate and remove mw.eventLog.submitInteraction().Jan 23 2026, 1:41 PM
Sfaci added a subtask: T415362: Deprecate and remove mw.eventLog.submitInteraction().
Sfaci added a subtask: T415579: Migrate JS and PHP client libraries to TestKitchen extension.Jan 26 2026, 5:46 PM
Sfaci added a subtask: T415654: Migrate CheckUser PHP instrument to use Test Kitchen SDK.Jan 27 2026, 11:54 AM
Sfaci added a subtask: T415650: Migrate ReportIncident PHP instrument to use Test Kitchen SDK.
Milimetric moved this task from Incoming (new tickets) to Tag with Radar on the Data-Engineering board.Jan 28 2026, 5:27 PM
Sfaci mentioned this in T416020: Deprecate and remove EventLogging.MetricsClientFactory service.Jan 30 2026, 4:17 PM
Sfaci added a subtask: T416020: Deprecate and remove EventLogging.MetricsClientFactory service.
Sfaci added a subtask: T416021: Migrate CreateAccount PHP instrument (from WikimediaEvents) to use TestKitchen SDK.Jan 30 2026, 4:23 PM
Sfaci mentioned this in T407905: Update name in GrowthExperiments and ReaderExperiments extensions.Jan 30 2026, 4:32 PM
Sfaci added a comment.Jan 30 2026, 4:43 PM

Related to my question in https://phabricator.wikimedia.org/T415246#11548974 (and a couple of messages below) about what to do with usages of $this->metricsClientFactory->newMetricsClient( $context ), I have filed T416020: Deprecate and remove EventLogging.MetricsClientFactory service and some other related tickets to migrate the instruments that are using this service (now they are subtasks of the mentioned ticket).

The only pending one is related to GrowthExperiments extension. They are also using the EventLogging.MetricsClientFactory service. We have right now T407905: Update name in GrowthExperiments and ReaderExperiments extensions to work on some renaming and I have posted there a message to confirm what we are going to do regarding that (to use a separate ticket or the current one)

phuedx created subtask T417584: Deprecate and remove/reintegrate the ext.eventLogging.metricsPlatform.Feb 16 2026, 1:50 PM
KReid-WMF closed subtask T415579: Migrate JS and PHP client libraries to TestKitchen extension as Resolved.Mar 12 2026, 3:07 PM
KReid-WMF closed subtask T415210: Deprecate and remove mw.eventLog.submitClick() as Resolved.Thu, Apr 2, 5:05 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits