Telemetry/Custom dashboards with re:dash: Difference between revisions
(→Longitudinal Data: Moving reference link to the front of the intro) |
(Replaced the stub installer ping section with a link to the new in-tree docs) |
||
(9 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
Re:dash allows you to connect to various data sources via an interactive SQL frontend. You can then share your queries with peers, create visualizations, or combine these into an automatically updating dashboard. | Re:dash allows you to connect to various data sources via an interactive SQL frontend. You can then share your queries with peers, create visualizations, or combine these into an automatically updating dashboard. | ||
Check it out at [sql.telemetry.mozilla.org]. re:dash is also known as stmo, an abbreviation of it's URL. | Check it out at [http://sql.telemetry.mozilla.org sql.telemetry.mozilla.org]. re:dash is also known as stmo, an abbreviation of it's URL. | ||
== | ==Running Queries== | ||
re:dash uses SQL to query the data sources. New queries are created by pressing "New Query" below the header. Queries run here will return the data below in tabular form. | |||
Save the query by changing the name. | |||
===Creating Visualizations=== | |||
The data from these queries can be used to power visualizations. Press "New Visualization" to create a visual from the query output. re:dash supports bar, line, area, pie, and scatter charts. | |||
===Creating Dashboards=== | |||
Dashboards are created on the s.t.m.o main page - click on "Create Dashboard". Once you name your dashboard, you can add queries you've saved by clicking "Add Widget" under the settings (three dots in the right corner). | |||
Re:dash also supports filters and nested dashboards, see the [http://docs.redash.io/en/latest/usage/special_features.html re:dash special features]. | |||
==Available Data Sources== | |||
re:dash is data source agnostic. As such we have many different data sources available, where each will have their own tables to query from. | |||
To choose a different data source, select it from the dropdown next to "Data Source". To see what tables are available, simply select the data source and execute <code>show tables</code>. Some data sources will have the tables and schemas show up in a table to the left of the query writing field. | |||
===Presto=== | |||
We have a variety of datasets available in a Presto instance. Most notably, the derived datasets generated by [https://github.com/mozilla/telemetry-batch-view telemetry-batch-view] (longitudinal, cross-sectional, main-summary, etc). See the [https://wiki.mozilla.org/Telemetry/Available_Telemetry_Datasets_and_their_Applications Full Documentation] for more information. | |||
===Stub Installer Ping Dataset=== | |||
This set includes data describing install success rates for Windows users. Information on this data can be found in the [https://firefox-source-docs.mozilla.org/browser/installer/windows/installer/StubPing.html Firefox source tree documentation]. | |||
===Google Sheets=== | ===Google Sheets=== | ||
Line 21: | Line 44: | ||
* You should see your spreadsheet data appear in re:dash | * You should see your spreadsheet data appear in re:dash | ||
==Accessing re:dash data externally== | |||
Re:dash has the capability to make the data accessible via an HTTP request. See [https://gist.github.com/robotblake/aaa6f35195f6466aa8086be8162dd33a accessing re:dash results externally]. | |||
==Other Resources== | ==Other Resources== | ||
* [https://robertovitillo.com/2016/03/27/telemetry-meets-sql/] | * [https://robertovitillo.com/2016/03/27/telemetry-meets-sql/ Telemetry Meets SQL] | ||
* [https://prestodb.io/docs/current/sql.html Presto SQL Syntax] |
Latest revision as of 17:36, 26 February 2018
Introduction
Re:dash allows you to connect to various data sources via an interactive SQL frontend. You can then share your queries with peers, create visualizations, or combine these into an automatically updating dashboard.
Check it out at sql.telemetry.mozilla.org. re:dash is also known as stmo, an abbreviation of it's URL.
Running Queries
re:dash uses SQL to query the data sources. New queries are created by pressing "New Query" below the header. Queries run here will return the data below in tabular form.
Save the query by changing the name.
Creating Visualizations
The data from these queries can be used to power visualizations. Press "New Visualization" to create a visual from the query output. re:dash supports bar, line, area, pie, and scatter charts.
Creating Dashboards
Dashboards are created on the s.t.m.o main page - click on "Create Dashboard". Once you name your dashboard, you can add queries you've saved by clicking "Add Widget" under the settings (three dots in the right corner).
Re:dash also supports filters and nested dashboards, see the re:dash special features.
Available Data Sources
re:dash is data source agnostic. As such we have many different data sources available, where each will have their own tables to query from.
To choose a different data source, select it from the dropdown next to "Data Source". To see what tables are available, simply select the data source and execute show tables
. Some data sources will have the tables and schemas show up in a table to the left of the query writing field.
Presto
We have a variety of datasets available in a Presto instance. Most notably, the derived datasets generated by telemetry-batch-view (longitudinal, cross-sectional, main-summary, etc). See the Full Documentation for more information.
Stub Installer Ping Dataset
This set includes data describing install success rates for Windows users. Information on this data can be found in the Firefox source tree documentation.
Google Sheets
To access a Google Sheet from re:dash:
- Share the spreadsheet with "gspread@pipeline-sql-prod.iam.gserviceaccount.com".
- Google will warn you that this address is not within Mozilla. Click "OK"
- Find the document ID for the given spreadsheet.
- For example, a URL like "https://docs.google.com/spreadsheets/d/1-DaBLABLAmu_lVGunk8I/edit#gid=1507574279" has an id of "1-DaBLABLAmu_lVGunk8I"
- Paste this id into the query box in sql.telemetry.mozilla.org. As an example, see https://sql.telemetry.mozilla.org/queries/476/source
- You should see your spreadsheet data appear in re:dash
Accessing re:dash data externally
Re:dash has the capability to make the data accessible via an HTTP request. See accessing re:dash results externally.