Skip to main content

chaosdb: Chaostoolkit storeevent Control

This control allows you to store events on a configurable data store. The data store can then be used to monitor events on a monitoring dashboard or to collect events on a time series datastore. The control currently implements the following drivers:

  • an influx driver to store events on a InfluxDB time series database
  • a grafana driver to store events on a Grafana server as annotations

The grafana driver supports the following authentication types:

  • basic auth (username/password)
  • bearer API token

To understand what a chaos-toolkit control is please refer to the official documentation on controls.

The Influx driver

InfluxDB is one of the most used time series data stores, it's implemented in golang and therefore is pretty fast and very easy to install and set up. Moreover, if you use Gatling for your performance input load simulations, it is pretty simple to store Gatling metrics on InfluxDB as well (as the Influx server can be configured to accept data in the graphite protocol), so you can use the same Influx data store for Gatling metrics and chaos toolkit events.

You can configure the Influx driver setting these parameters in the configuration section (the values provided represent the defaults):

    "configuration": {
      "influxdb": {
        "host": "localhost",
        "port": 8086,
        "http_endpoint": "/write",
        "database": "gatlingdb"
      }
    }

Then, at the proper level, configure the control driver:

            "controls": [
                {
                    "name": "tracing",
                    "provider": {
                        "type": "python",
                        "module": "chaosdb.influx"
                    }
                }
            ],

The Grafana driver

The Grafana driver can be quite convenient if you use grafana for your dashboards. The driver sends chaos-toolkit events directly to Grafana using the Annotation HTTP API. Moreover it is able to draw a region annotation around the whole experiment, making experiment visualization more visible.

The grafana configuration section is keyed "grafana". The grafana driver accepts a list of configuration sections, one for each grafana server you want to send annotations to. Each section accepts the following configuration attributes:

Attribute Description
host the grafana server fqdn
port the grafana service port
protocol http/https (defaults to http if not set)
api_token grafana API token (not mandatory)
cert_file file where the TSL certificate is stored (not mandatory)
username the simple auth user name (not mandatory)
password the simple auth password (not mandatory)
dashboardId a specific dashboard ID (all in case it's not specified or 0)
only_actions a boolean flag to send only actions or probes as well (defaults to false)
tags a list of custom tags to tag annotations
annotation_api_endpoint defaults to '/api/annotations'

The 'dashboardId' parameter points to the dashboard annotations are added to, otherwise annotations will be displayed on all dashboards.

The 'only_actions' parameter allows to trace only actions, not probes. The 'tags' parameter allows to add custom tags to each annotation.

Then, at the proper level, configure the control driver:

            "controls": [
                {
                    "name": "tracing",
                    "provider": {
                        "type": "python",
                        "module": "chaosdb.grafana"
                    }
                }
            ],

Metadata

Release files for chaosdb 0.2.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chaosdb 0.2.12
File Size Uploaded Provenance Actions
chaosdb-0.2.12.tar.gz 13.1 kB Without provenance Details for chaosdb-0.2.12.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for chaosdb 0.2.12
File Interpreter ABI Platform Actions
chaosdb-0.2.12-py2.py3-none-any.whl Python 3, Python 2 none any Details for chaosdb-0.2.12-py2.py3-none-any.whl

Total release size: 28.5 kB

Release files / chaosdb-0.2.12.tar.gz

Download URL chaosdb-0.2.12.tar.gz
Size 13.1 kB
Tags Source
SHA-256 checksum
How to use checksums
5f22f9cc911bff5482e7a1e8c32dbba1d2b714c8a674d6d76459a60e433f10f4
BLAKE2b-256 checksum
How to use checksums
39ef2ae3fa0b3a5525f4e7acd76a84c5cd451ce88810b68f8ee6823a2836626f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.1

Release files / chaosdb-0.2.12-py2.py3-none-any.whl

Download URL chaosdb-0.2.12-py2.py3-none-any.whl
Size 15.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
916befec4ef23bb4fbf6777d3efcb55c9a7f8397746908e5c5624be9dbd1b318
BLAKE2b-256 checksum
How to use checksums
4f86f765fe398a17ea0b2fe9c74ed3287490426d43a6f494a9c8d50980c6b7ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.1

Security for chaosdb 0.2.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page