openstack
/
stackviz
Code Issues Proposed changes
Performance and debugging visualization for DevStack and Tempest
273 Commits 1 Branch 0 Tags 2.3 MiB
SCSS 58.2%
JavaScript 28.8%
Python 9.2%
HTML 3.8%
Go to file
Doug Hellmann 7bdfa37299 switch documentation job to new PTI 
This is a mechanically generated patch to switch the documentation
jobs to use the new PTI versions of the jobs as part of the
python3-first goal.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I0b373b18715fec1bed6894bb324d104fb78893e6
Story: #2002586
Task: #24327
 		2018-09-08 22:54:04 -04:00
app Fix timeline worker sorting 2016-07-18 11:23:03 -06:00
doc/source Fix indentations in docs 2017-12-18 13:50:02 +09:00
gulp Have stackviz output a usable python sdist 2017-05-31 09:14:10 -04:00
stackviz Adapt to python 3 2017-04-11 09:37:46 -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 Have stackviz output a usable python sdist 2017-05-31 09:14:10 -04: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
.zuul.yaml switch documentation job to new PTI 2018-09-08 22:54:04 -04:00
CONTRIBUTING.rst Fix indentations in docs 2017-12-18 13:50:02 +09: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 Have stackviz output a usable python sdist 2017-05-31 09:14:10 -04:00
README.rst Fix indentations in docs 2017-12-18 13:50:02 +09:00
babel.cfg Add stub unit tests from cookiecutter 2015-08-03 10:37:55 -06:00
bindep.txt Install "node-legacy" for build 2017-06-13 16:30:27 +10:00
gulpfile.js Add initial Angular boilerplate files. 2015-09-25 16:26:44 -06:00
package.json Have stackviz output a usable python sdist 2017-05-31 09:14:10 -04:00
requirements.txt Drop mysql-python 2017-04-06 21:59:58 +00:00
setup.cfg Merge "Have stackviz output a usable python sdist" 2017-05-31 16:02:27 +00: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 Fix docs and update its theme 2017-12-01 16:31:09 +09:00
tox.ini Drop mysql-python 2017-04-06 21:59:58 +00:00

README.rst

Team and repository tags

image

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

This will automatically build portable html/javascript and python utilities into dist/stackviz-VERSION.tar.gz.

You should probably install this into a virtualenv on the target system:

virtualenv stackviz
./virtualenv/bin/pip install /path/to/stackviz-VERSION.tar.gz
# to run stackviz export
./virtualenv/bin/stackviz-export

Note the required html will be placed in virtualenv/share/stackviz-html as a data-file (or elsewhere, if installed as a system package; this may vary on distributions). This can be moved as required. Note that all files in there 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 stackviz-html/data/ using stackviz-export like above.

Testing

  • Python tests: tox -e py27
  • 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