search

m-lab / telescope

[INACTIVE] Python framework that was designed to extract raw measurements from M-Lab to allow the easy production of research.
http://measurementlab.net
Apache License 2.0
19 stars 8 forks source link

readme

Measurement Lab: Telescope

INACTIVE / DEPRECATED Project

The Telescope project is no longer maintained. Code in the repository will not work with current M-Lab BigQuery tables and views.

Build Status Coverage Status

Dependencies

Packages

pip install -r requirements.txt

Test Dependencies

These additional packages are required to run Telescope unit tests.

pip install -r test-requirements.txt

Google Developer Console

Telescope requires the user to have a Google account with at least one project in Google Developer Console.

Note: Telescope makes queries against the M-Lab BigQuery dataset, which is free and therefore will not accrue charges against your account nor require Billing to be enabled.

To create a project:

  1. Go to https://console.developers.google.com
  2. Click the "Create Project" button
  3. Enter any value for Project Name and Project ID
  4. Click "Create"

QuickStart

  1. pip install -r requirements.txt
  2. Ensure that you have a project in the Google Developer Console (see above)
  3. python telescope/telescope.py documentation/examples/interconnection_study_example.json
  4. The first time you run Telescope, it will prompt you to grant OAuth permission to your Google account in order to make queries to the M-Lab datastore in BigQuery
  5. When OAuth authentication completes, Telescope will perform the queries specified by the selector file. The queries may take between 45 seconds and 10 minutes to comlete.

When all queries complete, the results will be placed in the processed/ folder. Each output file will contain results for the specified metric in CSV format of (UNIX timestamp, value).

Working with Selector Files

Telescope takes as input "selector files," which specify what data to retrieve. Example selector files are available in documentation/examples. It is simple to modify these example selector files to instruct Telescope to retrieve the data of your choice. Full documentation of selector files is available in documentation/selector-file-spec.md.