Chaos Toolkit OpenTracing Extension
Project description
Chaos Toolkit Extension for Open Tracing
This project is an extension for the Chaos Toolkit for OpenTracing and OpenTelemetry.
Here is an example of what it could look like with the Jaeger backend.
Install
This package requires Python 3.6+
To be used from your experiment, this package must be installed in the Python environment where chaostoolkit already lives.
$ pip install -U chaostoolkit-opentracing
Usage
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.
NOTE: Please see at the bottom of the page all the supported clients and exporters this control supports.
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": "127.0.0.1",
"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 127.0.0.1:6831
(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.
controls:
opentracing:
provider:
type: python
module: chaostracing.control
arguments:
provider: jaeger
host: 127.0.0.1
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 = tracer.scope_manager.active
parent = scope.span
with tracer.start_span("call-service1", child_of=parent) as span:
span.set_tag('http.method','GET')
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
Jaeger tracer
The Jager tracer relies on the OpenTracing protocol which has now be superseded by OpenTelemetry. However, we still provide support for it.
To install the necessary dependencies for the Jaeger tracer, please run:
$ pip install -U jaeger-client~=4.8
Use the following configuration:
{
"configuration": {
"tracing_provider": "jaeger",
"tracing_host": "127.0.0.1",
"tracing_port": 6831,
"tracing_propagation": "b3"
},
"controls": [
{
"name": "opentracing",
"provider": {
"type": "python",
"module": "chaostracing.control"
}
}
]
}
OpenTelemetry provider
To install the baseline dependencies for the OpenTelemetry tracer, please run:
$ pip install -U opentelemetry-api \
opentelemetry-sdk \
opentelemetry-opentracing-shim
Jaeger thrift exporter
If you want to export using the Jaeger thrift protocol, please install:
$ pip install opentelemetry-exporter-jaeger-thrift
Use the following configuration:
{
"configuration": {
"tracing_provider": "opentelemetry",
"tracing_opentelemetry_exporter": "jaeger-thrift",
"tracing_host": "127.0.0.1",
"tracing_port": 6831
},
"controls": [
{
"name": "opentracing",
"provider": {
"type": "python",
"module": "chaostracing.control"
}
}
]
}
Jaeger grpc exporter
If you want to export using the Jaeger grpc protocol, please install:
$ pip install opentelemetry-exporter-jaeger-grpc
Use the following configuration:
{
"configuration": {
"tracing_provider": "opentelemetry",
"tracing_opentelemetry_exporter": "jaeger-grpc",
"tracing_opentelemetry_collector_endpoint": "localhost:14250",
"tracing_opentelemetry_collector_endpoint_insecure": true
},
"controls": [
{
"name": "opentracing",
"provider": {
"type": "python",
"module": "chaostracing.control"
}
}
]
}
OLTP grpc exporter
If you want to export using the OLTP grpc protocol, please install:
$ pip install opentelemetry-exporter-oltp-grpc
Use the following configuration:
{
"configuration": {
"tracing_provider": "opentelemetry",
"tracing_opentelemetry_exporter": "oltp-grpc",
"tracing_opentelemetry_collector_endpoint": "http://localhost:4317",
"tracing_opentelemetry_collector_endpoint_insecure": true
},
"controls": [
{
"name": "opentracing",
"provider": {
"type": "python",
"module": "chaostracing.control"
}
}
]
}
OLTP HTTP exporter
If you want to export using the OLTP HTTP protocol, please install:
$ pip install opentelemetry-exporter-oltp-http
Use the following configuration:
{
"configuration": {
"tracing_provider": "opentelemetry",
"tracing_opentelemetry_exporter": "oltp-http",
"tracing_opentelemetry_collector_endpoint": "http://localhost:4318",
"tracing_opentelemetry_collector_endpoint_insecure": true
},
"controls": [
{
"name": "opentracing",
"provider": {
"type": "python",
"module": "chaostracing.control"
}
}
]
}
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for chaostoolkit-opentracing-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c15882d5885009262b5f3a0e0909f211ce01c943b6599f2069fb2aac3dbdfff |
|
MD5 | 4a783b335e33b2654eb10e27bf0ed403 |
|
BLAKE2b-256 | da4c9448cb015b9c587a4add74487c4027eaeed7ede02d648882b32bb5327ed4 |
Hashes for chaostoolkit_opentracing-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f257b265e8c1e677e82aa43bbe9b4f239234e12151ac229e591cff6e7bcf608 |
|
MD5 | c998466d974064c1e578d93975aa673d |
|
BLAKE2b-256 | a63c1e8ba6d5b4025878219f73f521d3f9bc0c46e8ab39fa3d800e2fe31d6ee2 |