Until MPIC or the experimentation platform becomes the canonical source of instrument documentation, create a public, on-wiki process for documenting instruments. This will be a lightweight, flexible process intended to be an interim solution.
See also:
- https://wikitech.wikimedia.org/wiki/Metrics_Platform/Deployed_Streams
## Notes
Based on searching for `metrics_platform_client` in https://gerrit.wikimedia.org/r/plugins/gitiles/operations/mediawiki-config/+/refs/heads/master/wmf-config/ext-EventStreamConfig.php, there are 12 active events streams using Metrics Platform:
- android.product_metrics.article_link_preview_interaction
- schema: analytics/product_metrics/app/base (https://schema.wikimedia.org/repositories//secondary/jsonschema/analytics/product_metrics/app/base/latest)
- android.product_metrics.article_toc_interaction
- schema: analytics/mobile_apps/product_metrics/android_article_toc_interaction
- android.product_metrics.article_toolbar_interaction
- schema: analytics/product_metrics/app/base
- android.product_metrics.find_in_page_interaction
- schema: analytics/mobile_apps/product_metrics/android_find_in_page_interaction
- mediawiki.web_ui_actions
- location: WikimediaEvents
- https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/WikimediaEvents/+/refs/heads/master/OWNERS.md#click_tracking-for-vector-and-minerva
- schema: analytics/mediawiki/product_metrics/web_ui_actions
- mediawiki.web_ui_scroll_migrated
- location: WikimediaEvents
- https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/WikimediaEvents/+/refs/heads/master/OWNERS.md#scroll_tracking-for-vector
- schema: analytics/product_metrics/web/base
- mediawiki.reference_previews
- schema: analytics/mediawiki/client/metrics_event
- wikibase.client.interaction
- schema: analytics/product_metrics/web/base
- wikifunctions.ui
- schema: analytics/mediawiki/client/metrics_event
- docs: https://datahub.wikimedia.org/dataset/urn:li:dataset:(urn:li:dataPlatform:hive,event.wikifunctions_ui,PROD)/Documentation?is_lineage_mode=false
- mediawiki.product_metrics.wikifunctions_ui
- schema: analytics/mediawiki/product_metrics/wikilambda/ui_actions
- mediawiki.product_metrics.wikilambda_api
- schema: analytics/mediawiki/product_metrics/wikilambda/api
- mediawiki.product_metrics.mint_for_readers
- schema: analytics/product_metrics/web/base
### Questions
- Does one stream correspond to one instrument?
- There are a few streams in the config that I can't find anywhere in code: wikifunctions.ui and mediawiki.reference_previews
- What's the relationship between wikifunctions.ui and mediawiki.product_metrics.wikifunctions_ui?
- Based on `T355438`, it looks like wikifunctions.ui uses the old MP monoschema.
- Some streams (like mediawiki.reference_previews) have an `events` property inside `metrics_plaftorm_client`. What is this? Is this documented anywhere?
### Documentation elements
- Instrument name
- Stream name
- Location of instrument code
- Contact
- Schema
- Instrument data specification
- Measurement plan