openstack
/
stackviz
Code Issues Proposed changes
Performance and debugging visualization for DevStack and Tempest
256 Commits 1 Branch 0 Tags 2.2 MiB
SCSS 58.1%
JavaScript 28.8%
Python 9.3%
HTML 3.8%
Go to file
nizam 0cd69dee8b Update .coveragerc after the removal of openstack directory 
The openstack directory was used to keep codes from oslo-incubator,
we have retired oslo-incubator,so don't use this directory any more.

Change-Id: I66deba146f1669b070dac0ecc72e350822612cf8
 		2016-11-03 19:33:33 +05:30
app Fix timeline worker sorting 2016-07-18 11:23:03 -06:00
doc/source Correct stream-file argument 2016-09-02 10:53:11 +10:00
gulp Disable gzip and source maps for production builds 2016-05-13 18:40:17 -06:00
stackviz Add new configuration file format 2016-04-21 16:21:52 -06:00
test Add new configuration file format 2016-04-21 16:21:52 -06:00
.coveragerc Update .coveragerc after the removal of openstack directory 2016-11-03 19:33:33 +05:30
.eslintignore Switch to eslint. 2015-11-18 15:36:36 -07:00
.eslintrc.json Fix phantomjs package error and update eslint-config-openstack 2016-03-10 13:34:03 -07:00
.gitignore Add *.log to .gitignore 2016-05-31 15:55:16 +09:00
.gitreview Add .gitreview file 2015-09-14 15:59:30 -06:00
.testr.conf Add more test cookiecutter template items 2015-08-03 11:26:08 -06:00
CONTRIBUTING.rst Add to stackviz-export and stackviz-front docs 2016-04-14 10:18:28 -06:00
HACKING.rst Add .gitignore entries, HACKING.rst, and __init__.py contents from cookiecutter 2015-08-03 10:01:01 -06:00
LICENSE Add some missing base files from cookiecutter (LICENSE, manifest, setuptools config) 2015-08-03 09:11:51 -06:00
MANIFEST.in Include bower components during `setup.py install`, and use properly use relative static directory during export. 2015-08-13 14:45:09 -06:00
README.rst Add to stackviz-export and stackviz-front docs 2016-04-14 10:18:28 -06:00
babel.cfg Add stub unit tests from cookiecutter 2015-08-03 10:37:55 -06:00
gulpfile.js Add initial Angular boilerplate files. 2015-09-25 16:26:44 -06:00
package.json Use d3 modules to reduce build size 2016-05-28 15:36:34 -06:00
requirements.txt Remove all Django-related functionality. 2015-09-30 13:25:30 -06:00
setup.cfg Update home-page url 2016-09-06 09:59:25 +08:00
setup.py Add some missing base files from cookiecutter (LICENSE, manifest, setuptools config) 2015-08-03 09:11:51 -06:00
test-requirements.txt Remove duplicated imports from test-requirements.txt 2016-06-13 14:46:19 +09:00
tox.ini Delete *openstack/common* in exclude 2016-09-11 06:06:13 +00:00

README.rst

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:

https://github.com/timothyb89/stackviz-deployer

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 install

Installation - 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 dev

This 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 prod

The 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