openstack
/
stackviz
Code Issues Proposed changes
Performance and debugging visualization for DevStack and Tempest
292 Commits 1 Branch 0 Tags 2.2 MiB
SCSS 58.1%
JavaScript 28.8%
Python 9.3%
HTML 3.8%
Go to file
OpenDev Sysadmins a32888e592 OpenDev Migration Patch 
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
 		2019-04-19 19:36:20 +00:00
app Fix the misspelling of "register" 2019-01-23 16:56:13 +08: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
playbooks/legacy/periodic-package-stackviz-element OpenDev Migration Patch 2019-04-19 19:36:20 +00:00
stackviz Treat subunit as binary under python3 2018-09-30 08:44:55 -07: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 OpenDev Migration Patch 2019-04-19 19:36:20 +00:00
.testr.conf Add more test cookiecutter template items 2015-08-03 11:26:08 -06:00
.zuul.yaml Merge "Move legacy-periodic-package-stackviz-element job to stackviz repo" 2019-03-27 06:42:06 +00:00
CONTRIBUTING.rst Fix indentations in docs 2017-12-18 13:50:02 +09:00
HACKING.rst Use updated hacking url link 2018-10-17 02:33:00 +00: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 add python 3.6 unit test job 2018-09-12 18:00:05 +02: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 Treat subunit as binary under python3 2018-09-30 08:44:55 -07:00
setup.cfg Update home-page 2019-01-12 12:11:00 +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 Treat subunit as binary under python3 2018-09-30 08:44:55 -07:00
tox.ini Merge "Add py36 and py37 tox envs" 2019-03-15 00:54:12 +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