Skip to main content

Chaos Toolkit OpenTracing Extension

Project description

Chaos Toolkit Extension for Open Tracing

Build Status Python versions

This project is an extension for the Chaos Toolkit for [OpenTracing 2][].

Here is an example of what it could look like with the Jaeger backend.



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


Currently, this extension only provides control support to send traces to your provider during the execution of the experiment. It does not yet expose any probes or actions per-se.

Declare within the experiment

To use this control, you can declare it on a per experiment basis like this:

    "configuration": {
        "tracing_provider": "jaeger",
        "tracing_host": "",
        "tracing_port": 6831,
        "tracing_propagation": "b3"
    "controls": [
            "name": "opentracing",
            "provider": {
                "type": "python",
                "module": "chaostracing.control"

This will automatically create a Jaeger client to emit traces onto the address (over UDP).

Declare within the settings

You may also declare the control to be applied to all experiments by declaring the control from within the Chaos Toolkit settings file. In that case, you do not need to set the configuration or the controls at the experiment level and the control will be applied to every experiments you run.

      type: python
      module: chaostracing.control
        provider: jaeger
        port: 6831
        propagation: b3

Send traces from other extensions

You may also access the tracer from other extensions as follows.

For instance, assuming you have an extension that makes a HTTP call you want to trace specifically, you could do this from your extension's code:

from chaoslib import Configuration, Secrets
import requests
import opentracing

def some_function(configuration: Configuration, secrets: Secrets):
    tracer = opentracing.global_tracer()
    scope =
    parent = scope.span

    with tracer.start_span("call-service1", child_of=parent) as span:
        span.set_tag('http.url', url)
        span.set_tag('span.kind', 'client')
        span.tracer.inject(span, 'http_headers', headers)

        r = requests.get(url, headers=headers)
        span.set_tag('http.status_code', r.status_code)

Because the opentracing exposes a noop tracer when non has been initialized, it should be safe to have that code in your extensions without having to determine if the extension has been enabled in the experiment.

Please note that, Open Tracing scope cannot be shared across threads (while spans can). So, when running this in a background activity, the tracer will not actually be set to the one that was initialized.

Open Tracing Provider Support

For now, only the Jaeger tracer is supported but other backends will be added as need be in the future.

Jaeger tracer

To install the necessary dependencies for the Jaeger tracer, please run:

$ pip install -U jaeger-client~=4.1


To run the tests for the project execute the following:

$ pytest


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-opentracing, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size chaostoolkit_opentracing-0.2.1-py3-none-any.whl (10.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size chaostoolkit-opentracing-0.2.1.tar.gz (13.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page