/chaostoolkit-humio

Extension for integrating with Humio

Primary LanguagePythonApache License 2.0Apache-2.0

chaostoolkit-humio

Build Status

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

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-humio

Humio Dataspace & Token

To use this extension, you will need two pieces of information from Humio. First, the dataspace which you want to send logs to. Second a API token for an user with permissions to that space.

Usage

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

notifications:
  -
    type: plugin
    module: chaoshumio.notification
    space: my-space
    token: my-token

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

notifications:
  -
    type: plugin
    module: chaoshumio.notification
    space: my-space
    token: my-token
    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.