Page MenuHomePhabricator

WikiLambda: Define Metrics Platform stream(s) for initial event logging
Closed, ResolvedPublic

Description

Description

Metrics Platform provides the least-effort approach to instrument WikiLambda for event logging, and appears to meet our needs (subject to further analysis). Once we've defined one or more streams, it's very easy to start creating instruments in JavaScript and/or PHP code.

No schema creation is needed; MP relies on a predefined "monoschema".

The essential requirement for defining an MP stream is to determine which of the predefined "contextual values" should be added to the stream's events, by MP. (Note: In addition to these contextual values, event-specific "custom values" can be specified by each instrument. These custom values are not mentioned in the stream's definition.)

If our initial logging is focused on function editing steps, some candidates for contextual values (i.e., keys for the values) would be: agent.client_platform_family (indicates mobile versus desktop device), page.id, page.title, page.revision_id, performer.is_logged_in, performer.id, performer.name, performer.session_id, performer.language, performer.language_variant, performer.edit_count. Note: if a value for any of these keys isn't available when a particular event is created, MP handles it gracefully (e.g., by inserting a null value).

Once these contextual values have been determined, and a stream name chosen, the stream can be declared in ext-EventStreamConfig.php, for production and beta, or in InitialiseSettings-labs.php, for beta only.

Relevant documentation is at Metrics_Platform/Creating_a_Stream_Configuration and related pages. Example MP stream definitions can be found in ext-EventStreamConfig.php, by searching for metrics_platform_client.

Desired behavior/Acceptance criteria


Completion checklist

Related Objects

StatusSubtypeAssignedTask
OpenBUG REPORTNone
ResolvedJdforrester-WMF
ResolvedBTullis
ResolvedJdforrester-WMF
ResolvedDVrandecic
Resolvedcmassaro
ResolvedClement_Goubert
ResolvedJdforrester-WMF
Resolvedcmassaro
Resolvedori
Resolvedsbassett
Resolvedakosiaris
ResolvedJdforrester-WMF
ResolvedRequest CCoxwell-WMF
ResolvedRequestgengh
ResolvedRequestArnoldokoth
Resolvedcmassaro
ResolvedQuiddity
ResolvedJdforrester-WMF
ResolvedJdforrester-WMF
ResolvedJdforrester-WMF
ResolvedJdforrester-WMF
ResolvedBUG REPORTgengh
ResolvedBUG REPORTgengh
Resolvedgengh
ResolvedBUG REPORTJdforrester-WMF
ResolvedBUG REPORTJdforrester-WMF
ResolvedBUG REPORTDVrandecic
ResolvedBUG REPORTcmassaro
ResolvedBUG REPORTJdforrester-WMF
ResolvedBUG REPORTAAlhazwani-WMF
DuplicateBUG REPORTNone
ResolvedBUG REPORTJdforrester-WMF
ResolvedBUG REPORTDVrandecic
Resolvedgengh
ResolvedBUG REPORTcmassaro
ResolvedBUG REPORTgengh
Resolvedgengh
ResolvedJdforrester-WMF
ResolvedJdforrester-WMF
Resolved CCoxwell-WMF
Resolved CCoxwell-WMF
ResolvedAAlhazwani-WMF
ResolvedLadsgroup
ResolvedJdforrester-WMF
ResolvedJdforrester-WMF
Resolvedcmassaro
ResolvedJdforrester-WMF
ResolvedDVrandecic
Resolvedgengh
ResolvedBUG REPORTJdforrester-WMF
ResolvedDMartin-WMF
ResolvedDMartin-WMF
ResolvedDMartin-WMF
ResolvedQuiddity
ResolvedQuiddity
ResolvedQuiddity
ResolvedDVrandecic
ResolvedDVrandecic
ResolvedQuiddity

Event Timeline

Change 922569 had a related patch set uploaded (by David Martin; author: David Martin):

[operations/mediawiki-config@master] Declare Metrics Platform stream for wikifunctionswiki on beta

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

Change 922569 merged by jenkins-bot:

[operations/mediawiki-config@master] Declare Metrics Platform stream for wikifunctionswiki on beta

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

Change 927801 had a related patch set uploaded (by David Martin; author: David Martin):

[operations/mediawiki-config@master] Add wikifunctions.ui to wgEventLoggingStreamNames in beta config

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

Change 927801 merged by jenkins-bot:

[operations/mediawiki-config@master] Add wikifunctions.ui to wgEventLoggingStreamNames in beta config

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

Change 928654 had a related patch set uploaded (by David Martin; author: David Martin):

[operations/mediawiki-config@master] Add wikifunctions.ui stream to metawiki

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

Change 928654 merged by jenkins-bot:

[operations/mediawiki-config@master] [BETA CLUSTER] Add wikifunctions.ui stream to metawiki wgEventStreams

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

Change 929317 had a related patch set uploaded (by David Martin; author: David Martin):

[operations/mediawiki-config@master] Correct the value for schema_title for stream wikifunctions.ui

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

Change 929317 merged by jenkins-bot:

[operations/mediawiki-config@master] Correct the value for schema_title for stream wikifunctions.ui

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

Change 931316 had a related patch set uploaded (by David Martin; author: David Martin):

[operations/mediawiki-config@master] Add '.' to events prefix & remove leading '/' from schema_title

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

Change 931316 merged by jenkins-bot:

[operations/mediawiki-config@master] Change sampling unit & 2 other revisions to wikifunctions.ui stream

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