Extension chaoshumio

Version 0.4.2
Repository https://github.com/chaostoolkit-incubator/chaostoolkit-humio

Build Status Python versions

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 Token

To use this extension, you will need one piece of information from Humio, the API token for a user.

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
    humio_url: https://myhumio.company.com
    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
    humio_url: https://myhumio.company.com
    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 to https://cloud.humio.com, add the following payload to your experiment:

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

If you want to send logs to a different Humio URL endpoint, specify the humio_url configuration parameter. The following shows how this parameter:

{
    "secrets": {
        "humio": {
            "token": {
                "type": "env",
                "key": "HUMIO_INGEST_TOKEN"
            }
        }
    },
    "configuration": {
        "humio_url": "https://myhumio.company.com"
    },
    "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 Humio. The experiment itself will also be send initially.

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.

Develop

If you wish to develop on this project, make sure to install the development dependencies. But first, create a virtual environment and then install those dependencies.

$ pip install -r requirements-dev.txt -r requirements.txt 

Then, point your environment to this directory:

$ pip install -e .

Now, you can edit the files and they will be automatically be seen by your environment, even when running from the chaos command locally.

Test

To run the tests for the project execute the following:

$ pytest

Exported Controls

This package exports controls covering the following phases of the execution of an experiment:

Level Before After
Experiment True True
Steady-state Hypothesis False True
Method False True
Rollback False True
Activities False True

To use this control module, please add the following section to your experiment:

{
  "provider": {
    "module": "chaoshumio.control",
    "type": "python"
  },
  "name": "chaoshumio"
}
name: chaoshumio
provider:
  module: chaoshumio.control
  type: python

This block may also be enabled at any other level (steady-state hypothesis or activity) to focus only on that level.

When enabled at the experiment level, by default, all sub-levels are also applied unless you set the automatic properties to false.

Exported Activities

notification


notify

Type
Module chaoshumio.notification
Name notify
Return None

Send a log message to the Humio ingest endpoint.

The settings must contain:

  • "token": a slack API token
  • "humio_url": the Humio endpoint to send the event to

If token is missing, no notification is sent. If humio_url is not specified then the default, https://cloud.humio.com, will be used.

Signature:

def notify(settings: Dict[str, Any], event: Dict[str, Any]):
    pass

Arguments:

Name Type Default Required
settings mapping Yes
event mapping Yes

Usage:

{
  "provider": {
    "arguments": {
      "event": {},
      "settings": {}
    },
    "module": "chaoshumio.notification",
    "func": "notify",
    "type": "python"
  },
  "name": "notify",
  "type": ""
}
name: notify
provider:
  arguments:
    event: {}
    settings: {}
  func: notify
  module: chaoshumio.notification
  type: python
type: ''