Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: e5cf7f8541
Fetching contributors…

Cannot retrieve contributors at this time

154 lines (96 sloc) 9.034 kb

Datazilla

Datazilla is a generic system for managing and visualizing data. The fundamental unit of data display in the user interface is called a data view. Data views can display data in any number of ways: tabular or graphical. Data views can also send signals to one another enabling the user to maintain visual context across multiple graphical displays of different data types. Each data view shares a toolbar that abstracts navigation, data presentation controls, and visual presentation. A prototype of datazilla was first developed in an application called bughunter.

This project includes a model, webservice, and web based user interface, and eventually it will support a local development environment.

This is a work in progress and will likely see a number of structural changes. It is currently being developed to manage Talos test data, a performance testing framework developed by mozilla for testing software products.

Architecture

At a top level datazilla can be described with three different parts: model, webservice, and UI.

All environment information is stored in datazilla/webapp/conf/etc/sysconfig/datazilla. Appropriate system information should be added to the environment variables in this file, then copy it to /etc/sysconfig/datazilla or whatever location is appropriate for your environment. It needs to be source'd before running any component of the system including command line scripts.

The environment variable called DATAZILLA_DEBUG, when set to true, causes all scripts and webservice methods to write out the full SQL, execution time, and host name for any database statement executed. This is handy for debugging any component in the system.

The web application is a django application found in datazilla/webapp/apps.

Model

The datazilla model classes rely on a module called datasource. This module encapsulates SQL manipulation. All of the SQL used by the system is stored in a JSON file format found in /datazilla/model/sql. There can be any number of SQL files stored in this format. The JSON structure allows a host type to be associated with each SQL statement.

UI

Building the Navigation Menu And Defining Data Views

New data views and collections of dataviews can be defined in the navigation menu by running the command:

   python datazilla/webapp/manage.py build_nav

This will read the json file datazilla/webapp/templates/data/views.json. This structure is translated into the View Navigation menu available on each data view. It also contains the definitions for the data views. The following is a definition of a data view in JSON.

   { "name":"test_runs",
     "default_load":1,
     "read_name":"Runs",
     "signals":{ "test_run_id":"1", "test_run_data":"1" },
     "control_panel":"test_selector.html",
     "data_adapter":"test_selector",
     "charts":[ { "name":"average_thumbnails", "read_name":"Averages", "default":"1" }, 
                { "name":"table", "read_name":"Table" } ]
   }

Attribute Definitions

   { "name": "Name of the data view",
     "default_load": "If this attribute is present, the data view will try to load data when it initializes",
     "read_name": "Readable name displayed in the UI",
     "signals": "List of signal names that the dataview can send and receive",
     "control_panel": "The html file name to use as the control panel.  Control panel files are located in datazilla/tree/master/webapp/media/html/control_panels",
     "data_adapter": "The data adapter in datazilla/webapp/media/js/data_views/DataAdapterCollection.js",
     "charts": "An array of associative arrays that define what type of visualizations the data view can render"
   }

Building the Cached Summaries

JS

Class Structures

The javascript that implements the user interface is constructed using a page/component/collection pattern thingy... whatever that means. This pattern was found to be very useful in separating out the required functionality, below is a brief definition of what that means in the data view UI architecture.

Page

Manages the DOM ready event, implements any top level initialization that's required for the page. An instance of the page class is the only global variable that other components can access, if they're playing nice. The page class instance is responsible for instantiating components and storing them in attributes. The page class also holds any data structures that need to be globally accessible to component classes.

Component

Contains the public interface of the component. A component can encapsulate any functional subset/unit provided in a page. The component will typically have an instance of a View and Model class. The component class is also responsible for any required event binding.

View

A component's view class manages interfacing with the DOM. Any CSS class names or HTML id's are defined as attributes of the view. Any HTML element modification is controlled with this class.

Model

A component's model manages any asynchronous data retrieval and large data structure manipulation.

Collection

A class for managing a collection of Components or classes of any type. A collection can also have a model/view if appropriate.

Client Application (datazilla/webapp/media/js/data_views)

This is not a complete file or class listing but is intended to give a top level description of the design pattern thingy of the data view javascript and what the basic functional responsibility of the pages/components/collections are.

#DataViewPage.js

DataViewPage Class - Manages the DOM ready event, component initialization, and retrieval of the views.json structure that is used by different components.

#Bases.js

Design Pattern Base Classes - Contains the base classes for Page, Component, Model, View etc...

#DataViewComponent.js

DataViewComponent Class - Encapsulates the behavior of a single data view using a model/view and provides a public interface for data view functionality. Manages event binding and registration.

DVViewView Class - Encapsulates all DOM interaction required by a data view.

BHViewModel Class - Encapsulates asynchronous server communication and data structure manipulation/retrieval.

#DataViewCollection.js

DataViewCollection Class - Manages operations on a collection of data views using a model/view including instantiating view collections.

DataViewCollectionView Class - Encapsulates all DOM interaction required by the collection.

DataViewCollectionModel Class - Provides an interface to the datastructures holding all data views and their associated parent/child relationships.

#DataAdapterCollection.js

DataAdapterCollection Class - Collection of DataViewAdapter class instances.

BHViewAdapter Class - Base class for all BHViewAdapters. Manages shared view idiosyncratic behavior like what fields go in the control panel and how to populate/retrieve them for signaling behavior.

CrashesAdapter Class - Derived class of BHViewAdapter. Encapsulates unique behavior for crash data views.

UrlAdapter Class - Derived class of BHViewAdapter. Encapsulates unique behavior for views containing URL summaries.

Installation

  1. Add system info to appropriate files in datazilla/webapp/conf/etc. Copy the files to there appropriate location under /etc.

  2. Start the datazilla, nginx, and memcached services. There is a startup script for the datazilla and nginx services in datazilla/webapp/conf/bin.

RHEL6 Configuration

This configuration was done on a RHEL6 VM.

  1. cat /etc/redhat-release to get the correct version of EPEL

  2. rpm -Uvh http://download.fedora.redhat.com/pub/epel/6/i386/epel-release-6-5.noarch.rpm

  3. yum install nginx fcgi Django Django-doc python-docutils MySQL-python python-flup

  4. yum install python-setuptools spawn-fcgi

  5. yum install mysql.x86_64 mysql-server.x86_64 mysql-devel.x86_64

  6. yum install git

  7. git clone https://github.com/jeads/datasource, python setup.py install

  8. yum install memcached.x86_64 python-memcached.noarch

  9. Modify the contents of files in the datazilla/webapp/conf/etc directory to meet the needs of your system and then copy the files to their corresponding locations under /etc.

Jump to Line
Something went wrong with that request. Please try again.