Mozilla Persona is "an identity system for the web." More specifically, it is a distributed, privacy-preserving single sign-on system for web sites and applications. Rather than having to manage multiple usernames and passwords, it allows you to sign in to a website using the email address of your choice.
As part of our goal to make Persona the best sign-in solution, we are continually working to streamline and improve the user experience. To better understand how our users are using the system, we collect certain statistics (suitably anonymized) about users' interaction with the interface.
The goal of the KPI dashboard is to present this information in a meaningful and informative manner.
The dashboard provides a number of different reports, visualizing the Key Performance Indicators (KPIs) of users interacting with the Persona dialog.
Sample KPIs include:
- Median number of sites a user logs into with Persona
- The drop-off rate of new users following the sign-in flow
- Percentage of successful password resets
- Percentage of users successfully activating additional email addresses
- Number of new users
As the dashboard is developed, other KPIs may be added (or may replace) these.
The interaction data collected in the Persona dialog is sent over and stored in the KPI Backend.
KPIggybank is an implementation of the backend that provides an interface for storing and retrieving this data. The KPI Dashboard will use KPIggybank's interface for accessing the data.
The location of the data server is defined in the configuration file found in
server/config/config.json.
An implementation of a server serving randomized interaction data (in the
expected format) is provided in server/scripts/fake_data_server.js. You can
run it using the command npm run-script data.
If you have your awsbox credentials setup, you can do this to get an instance of KPI Dashboard at https://somekpidashboard.personatest.org
./server/scripts/deploy.js deploy somekpidashboard -t c1.medium
Go get a cup of coffee, this will take a while.
If you get an error Error: Cannot retrieve metalink for repository: epel. then destory and deploy again.
Once this is complete, you may run:
ssh app@somekpidashboard.personatest.org
Edit /home/app/code/server/config/config.json
Make sure your verification_audience is correct. Example:
"verification_audience": "somekpidashboard.personatest.org",
To slurp in stage data, change your data_server. Example:
"data_server": {
"host": "kpiggybank.hacksign.in",
"port": 443,
"path": "/wsapi/interaction_data"
}
After a config change, we have to restart the server.
forever restartall
To import data...
cd code
./server/bin/update
This will populate the database with some recent data from data_server.
See mozilla/browserid and mozilla/awsbox for docs on restarting, pushing code, etc.
To run locally, continue reading prerequisites and running, below.
The KPI dashboard runs on NodeJS.
Once you have Node and npm, you can install additional
dependencies by running the command npm install.
We also require a running installation of Apache CouchDB 1.2.0 or newer.
Start the server with npm start. The server runs, by default, on port 3434.