Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Chaos Toolkit Humio Extension

Project description

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

This extension can be used a control on the experiment or a notification plugin of the Chaos Toolkit CLI itself. Usually, only one of these two methods is used at any given time as they serve similar purpose but feel free to combine them. The control approach is deeper because it logs down to the activity whereas notifications are much higher level.

Notification

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

notifications:
  -
    type: plugin
    module: chaoshumio.notification
    dataspace: 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
    dataspace: my-space
    token: my-token
    events:
      - run-failed
      - run-started

Only sends those two events.

Control

To use this extension as a control over the experiment and send logs during the execution of the experiment, add the following payload to your experiment:

{
    "secrets": {
        "humio": {
            "token": {
                "type": "env",
                "key": "HUMIO_INGEST_TOKEN"
            },
            "dataspace": {
                "type": "env",
                "key": "HUMIO_DATASPACE"
            }
        }
    },
    "controls": [
        {
            "name": "humio-logger",
            "provider": {
                "type": "python",
                "module": "chaoshumio.control",
                "secrets": ["humio"]
            }
        }
    ]
}

This will ensure the results of the experiment, steady-state, method, rollbacks and each activity are sent to your space. The experiment itself will also be send initially.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for chaostoolkit-humio, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size chaostoolkit_humio-0.3.0-py3-none-any.whl (6.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size chaostoolkit-humio-0.3.0.tar.gz (11.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page