chaostoolkit/reporting repository overview

⁠chaostoolkit-reporting

The Chaos Toolkit reporting extension library.

⁠Purpose

The purpose of this library is to provide reporting support to the Chaos Toolkit⁠ experiment results.

⁠Features

The library takes the journal generated by the chaos run command and transforms into a human friendly report. The report can be a standalone PDF or HTML document.

⁠Install

$ docker pull chaostoolkit/reporting

⁠Usage

To generate a PDF report using the Docker image:

$ ls .
journal.json

$ docker run \
    --user `id -u` \
    -v `pwd`:/tmp/result \
    -it \
    chaostoolkit/reporting

$ ls .
journal.json report.pdf chaostoolkit.log

As you can see, you should run that command from where the journal.json file, generated during an experiment run, can be found. This will create a report.pdf in this directory.

The file will be owned by the user id returned by the command id -u, it should be your user. The reason we specify a user is that, by default, the container runs as root and the image doesn't make a guess about which user will run the container. If you don't have the id command you can set the value manually as follows instead: --user 1000:1000 assuming both your user and group ids are 1000.

The default command of the image is equivalent to running this without a container:

$ chaos report --export-format=pdf journal.json report.pdf

If you wish to override that command, pass the chaos report parameters as follows:

$ docker run \
    --user `id -u` \
    -v `pwd`:/tmp/result \
    -it \
    chaostoolkit/reporting -- report --export-format=html5 journal-*.json report.html

$ ls .
journal-1.json journal-2.json report.html chaostoolkit.log

⁠Contribute

Contributors to this project are welcome as this is an open-source effort that seeks discussions⁠ and continuous improvement.

From a code perspective, if you wish to contribute, you will need to run a Python 3.5+ environment. Then, fork this repository and submit a PR. The project cares for code readability and checks the code style to match best practices defined in PEP8⁠. Please also make sure you provide tests whenever you submit a PR so we keep the code reliable.