d2e9ad4fca
This disables sourcemap generation for production builds to save on disk space. While useful, source maps are several times larger than our actual used code, so it's best to only keep them around during development. This also turns off gzip, since it is just duplicating files for now; we'll want to reconsider this feature once StackViz is building inside the gate if links start breaking. Change-Id: Ie4c2735c08014f417b8f1f68fc8f6b9e4898dff2
StackViz
A visualization utility to help analyze the performance of DevStack setup and Tempest executions. This repository can be cloned and built to use Stackviz with local run data. Stackviz is currently in the process of being implemented upstream (see Roadmap and Planning). To use Stackviz with upstream gate runs, please see the server deployment project at:
Installation
Installation - Frontend
- Installation of the frontend requires Node.js and Gulp. On Ubuntu::
-
sudo apt-get install nodejs npm nodejs-legacy sudo npm install -g gulp
Then, install the Node modules by running, from the project directory:
npm installInstallation - Processing
The data processor is a small Python module located in the same source tree. To install, run:
sudo pip install .Usage
Usage - Development
A development server can be run as follows:
gulp devThis will open a web browser and reload code automatically as it changes on the filesystem.
If you have subunit and dstat logs, you can create a config.json to display your runs:
stackviz-export -f <path/to/subunit> --dstat <path/to/dstat> app/data/During gulp dev, files written to app/data/
will be automatically synchronized with the browser. Note that these
files will not be copied to build/ during
gulp prod, but you can copy them manually using
gulp data.
Usage - Production
The production application can be build using:
gulp prodThe result will be written to ./build and should be
appropriate for distribution. Note that all files are not required:
- Directory structure (
js/,css/,fonts/,images/): required. - Static resources (
fonts/,images/): required. - Core files (
index.html,js/main.js,css/main.css): required unless gzipped versions are used. - Gzipped versions of core files (
*.gz): not required, but preferred. Use instead of plain core files to save on disk usage and bandwidth. - Source maps (
js/main.js.map,js/main.js.map.gz): only required for debugging purposes.
Data should be written to build/data/ using
stackviz-export like above. Note that the static production
code generated above is portable, and can be generated anywhere and
copied to another host to be combined with exported data.
Testing
- Python tests:
tox -epy27 - JavaScript unit tests:
gulp unit - JavaScript E2E tests:
gulp e2e
Manuals & Developer Docs
For more detailed information on how Stackviz works, please see the manuals located at doc/source/man/
Roadmap and Planning
- Planning: https://etherpad.openstack.org/p/stackviz
- Gate integration planning: https://etherpad.openstack.org/p/BKgWlKIjgQ