As a surveyor
I want to understand how my survey is performing soon after deploying it
So that I can correct course as necessary
As a maintainer
I want to understand how QuickSurveys is performing
So that I can respond as necessary
Background
QuickSurveys is observable but not immediately so:
- In order to know how many surveys are currently enabled, you must either:
- Search for wgQuickSurveysConfig in operations/mediawiki-config
- Navigate to a wiki and type mw.config.get( 'wgEnabledQuickSurveys', [] ) in your browser's console
- In order to determine how many users have seen a survey, you must query the event.QuickSurveysInitiation Hive table
- In order to determine how many users have engaged with a survey, you must query the event.QuickSurveysResponses Hive table
Overall Observability
The following information should be available in one place:
- How many surveys are enabled
- How quickly surveys are rendering
- How many surveys are seen
- How many surveys are being engaged with
Per-survey Observability
The above information should also be available on a per-survey basis.
TODO: Should the above information also be available on a per-country basis?
Post-deployment Tasks
- Create a dashboard in Grafana
- Update mw:Extension:QuickSurveys
- … at the very least, link to the dashboard
- Update the description of the QuickSurveys Phabricator project