f3848085e1
This patch changes the format of Stackviz docs so that all information is stored in the appropriate doc/source/ directory rather than all in README.rst. README.rst now just uses the RST include directive to get its text from doc/source/readme.rst. Usage and installation are now in their own RST files for increased modularity, and are included in doc/source/readme.rst. Additional developer documentation has also been created at doc/source/man/ and includes more information on stackviz-export as well as the AngularJS front-end. Change-Id: I1d37194add998cf83a66d380ec7390e31184bdb3
1.5 KiB
Python Data-Processing Module (stackviz-export)
The main purpose of stackviz-export is to parse subunit
and dstat logs in order to generate configuration files for the
AngularJS front-end.
Installation
Once Stackviz has been cloned into a suitable directory, setting up the module is as simple as:
sudo pip install .Usage
stackviz-export [options] <DEST>
Where DEST is the output directory of the module. If DEST does not exist, a new directory will be created. One of the following input options must be chosen:
- -f, --streamfile FILE
Specifies a subunit stream file to be used with the exporter. This argument can be used multiple times to specify additional subunit files.
- -i, --stdin
Instructs stackviz-export to read a subunit stream from stdin.
- -r, --repository REPOSITORY
Specifies a
.testrepositoryto read subunit streams from. This argument can be used multiple times to specify additional repositories.
Stackviz also visualizes machine utilization statistics using dstat. To attach a dstat.csv log to the subunit output, specify the following option:
- --dstat FILE
Specifies a csv-formatted dstat log file that corresponds with the provided subunit stream file.
Additional options:
- -h --help
Print help message.
- -z --gzip
Enables gzip compression for data files.