Dashboard generator for weekly Telemetry analyses.
Перейти к файлу
Roberto Agostino Vitillo 36c0d3a929 Add cljs middleware. 2014-08-24 19:09:07 +01:00
resources/public Fix filtering bug. 2014-08-19 14:34:46 +01:00
src Fix filtering bug. 2014-08-19 14:34:46 +01:00
LICENSE First commit. 2014-08-11 12:32:51 +01:00
README.md Update README.md 2014-08-15 15:05:29 +01:00
project.clj Add cljs middleware. 2014-08-24 19:09:07 +01:00

README.md

Telemetry Dashboard Generator

This clojurescript/om based dashboard can display and compare data collected with Telemetry on a weekly basis. It picks up a configuration file, specified through a GET parameter, that contains a description of the data format, e.g:

{
  "sort-options": {
    "values": ["Impact", "Popularity", "Median (ms)", "75% (ms)"],
    "selected": "Impact"
  },
  "filter-options": [
    {"id": "Application",
     "values": ["", "Firefox", "Fennec"],
     "selected": ""},
    {"id": "Platform",
     "values": ["", "WINNT", "Linux", "Darwin", "Android"],
     "selected": ""},
    {"id": "Measure",
     "values": ["", "startup_MS", "shutdown_MS"],
     "selected": ""},
    {"id": "Limit",
     "values": [10, 25, 100],
     "selected": 10}
  ],
  "title": ["Telemetry Add-on Performance", "Bootstrap add-on start up and shut down times"],
  "primary-key": ["Application", "Platform", "Addon ID", "Version", "Measure"],
  "header": ["Application", "Platform", "Addon ID", "Version", "Name", "Measure",
             "Sessions", "Popularity", "Impact", "Median (ms)", "75% (ms)", "95% (ms)"],
  "url-prefix": "https://s3-us-west-2.amazonaws.com/telemetry-public-analysis/addon_perf/data/weekly_addons"
}

Where

  • sort-options specifies the fields the dashboard should allow sorting on;
  • filter-options is a list of filter descriptors which specifiy the filterable columns and the allowed values to filter on;
  • primary-keys is the collection of fields that constitute the primary key which is used to identify uniquely a row;
  • url-prefix is the url prefix that the dashboard uses to concatenate the date of the requested dataset.

The filename for a dataset of a given week should follow the pattern: url-prefix20140804.csv.gz, where 20140804 is the date of the Monday of the requested week.