Performance and debugging visualization for DevStack and Tempest
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul b1a7a2679d Merge "Update home-page" 3 weeks ago
app Fix the misspelling of "register" 2 months ago
doc/source Fix indentations in docs 1 year ago
gulp Have stackviz output a usable python sdist 1 year ago
playbooks/legacy/periodic-package-stackviz-element Move legacy-periodic-package-stackviz-element job to stackviz repo 1 month ago
stackviz Treat subunit as binary under python3 6 months ago
test Add new configuration file format 3 years ago
.coveragerc Update .coveragerc after the removal of openstack directory 2 years ago
.eslintignore Switch to eslint. 3 years ago
.eslintrc.json Fix phantomjs package error and update eslint-config-openstack 3 years ago
.gitignore Have stackviz output a usable python sdist 1 year ago
.gitreview Add .gitreview file 3 years ago
.testr.conf Add more test cookiecutter template items 3 years ago
.zuul.yaml Merge "Move legacy-periodic-package-stackviz-element job to stackviz repo" 3 weeks ago
CONTRIBUTING.rst Fix indentations in docs 1 year ago
HACKING.rst Use updated hacking url link 6 months ago
LICENSE Add some missing base files from cookiecutter (LICENSE, manifest, setuptools config) 3 years ago
MANIFEST.in Have stackviz output a usable python sdist 1 year ago
README.rst Fix indentations in docs 1 year ago
babel.cfg Add stub unit tests from cookiecutter 3 years ago
bindep.txt add python 3.6 unit test job 7 months ago
gulpfile.js Add initial Angular boilerplate files. 3 years ago
package.json Have stackviz output a usable python sdist 1 year ago
requirements.txt Treat subunit as binary under python3 6 months ago
setup.cfg Update home-page 3 months ago
setup.py Add some missing base files from cookiecutter (LICENSE, manifest, setuptools config) 3 years ago
test-requirements.txt Treat subunit as binary under python3 6 months ago
tox.ini Merge "Add py36 and py37 tox envs" 1 month ago

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