Chaos Toolkit Plugin for Slack
Clone or download
Lawouach Log Slack API Call Output
Signed-off-by: Sylvain Hellegouarch <sh@defuze.org>
Latest commit 720b8e1 Mar 23, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
chaosslack Log Slack API Call Output Mar 23, 2018
tests first commit Feb 19, 2018
.gitignore first commit Feb 19, 2018
.travis.yml Install dev deps on build Feb 19, 2018
CHANGELOG.md Log Slack API Call Output Mar 23, 2018
LICENSE first commit Feb 19, 2018
README.md Explicit over implicit Feb 21, 2018
ci.bash first commit Feb 19, 2018
pytest.ini first commit Feb 19, 2018
requirements-dev.txt required for testing purpose Feb 20, 2018
requirements.txt Explicit over implicit Feb 21, 2018
setup.cfg first commit Feb 19, 2018
setup.py first commit Feb 19, 2018

README.md

Chaos Toolkit Extension for Slack

Build Status

This project is an extension for the Chaos Toolkit to target Slack.

Install

This package requires Python 3.5+

To be used from your experiment, this package must be installed in the Python environment where chaostoolkit already lives.

$ pip install -U chaostoolkit-slack

Slack Token

You can simply generate a legacy token. But you may also create a full Slack App and generate a token from it.

Usage

Currently, this extension only provides notification support to send Chaos Toolkit events to Slack channels.

To use this extension, edit your chaostoolkit settings by adding the following payload:

notifications:
  -
    type: plugin
    module: chaosslack.notification
    token: xop-1235
    channel: general

By default all events will be forwarded to that channel. You may filter only those events you care for:

notifications:
  -
    type: plugin
    module: chaosslack.notification
    token: xop-1235
    channel: general
    events:
      - run-failed
      - run-started

Only sends those two events.

Test

To run the tests for the project execute the following:

$ pytest

Contribute

If you wish to contribute more functions to this package, you are more than welcome to do so. Please, fork this project, make your changes following the usual PEP 8 code style, sprinkling with tests and submit a PR for review.

The Chaos Toolkit projects require all contributors must sign a Developer Certificate of Origin on each commit they would like to merge into the master branch of the repository. Please, make sure you can abide by the rules of the DCO before submitting a PR.